Cisco-IOS-XR-ipv6-ospfv3-cfg API API Reference
API generated from Cisco-IOS-XR-ipv6-ospfv3-cfg@2018-05-14.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
OSPFV3 - Update
Update operation of resource: ospfv3
ospfv3body object
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Create
Create operation of resource: ospfv3
ospfv3body object
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Delete
Delete operation of resource: ospfv3
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
PROCESSES - Update
Update operation of resource: processes
processesbody object
Request Content-Types: application/json
Request Example
{ { "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESSES - Create
Create operation of resource: processes
processesbody object
Request Content-Types: application/json
Request Example
{ { "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESSES - Delete
Delete operation of resource: processes
Successful operation
Internal Error
Response Content-Types: application/json
PROCESSES - Retrieve
Retrieve operation of resource: processes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
]
}
PROCESS - Update
Update operation of resource: process
processbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS - Create
Create operation of resource: process
processbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS - Delete
Delete operation of resource: process
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS - Retrieve
Retrieve operation of resource: process
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}, {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}, "af-name": "string",
"saf-name": "string"
}, {
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
DEFAULT-VRF - Update
Update operation of resource: default-vrf
default-vrfbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Create
Create operation of resource: default-vrf
default-vrfbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Delete
Delete operation of resource: default-vrf
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-VRF - Retrieve
Retrieve operation of resource: default-vrf
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}
AREA-ADDRESSES - Update
Update operation of resource: area-addresses
area-addressesbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Create
Create operation of resource: area-addresses
area-addressesbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Delete
Delete operation of resource: area-addresses
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Retrieve
Retrieve operation of resource: area-addresses
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-address": [ null ],
"area-area-id": [ null ]
}
AREA-ADDRESS - Update
Update operation of resource: area-address
area-addressbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Create
Create operation of resource: area-address
area-addressbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Delete
Delete operation of resource: area-address
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Retrieve
Retrieve operation of resource: area-address
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
RANGES - Update
Update operation of resource: ranges
rangesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Create
Create operation of resource: ranges
rangesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Delete
Delete operation of resource: ranges
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Retrieve
Retrieve operation of resource: ranges
ID of process-name
ID of address
Successful operation
Internal Error
RANGE - Update
Update operation of resource: range
rangebody object
ID of process-name
ID of address
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Create
Create operation of resource: range
rangebody object
ID of process-name
ID of address
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Delete
Delete operation of resource: range
ID of process-name
ID of address
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Retrieve
Retrieve operation of resource: range
ID of process-name
ID of address
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
NSSA - Update
Update operation of resource: nssa
nssabody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Create
Create operation of resource: nssa
nssabody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Delete
Delete operation of resource: nssa
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Retrieve
Retrieve operation of resource: nssa
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of address
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of address
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
NEIGHBORS - Update
Update operation of resource: neighbors
neighborsbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Create
Create operation of resource: neighbors
neighborsbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Delete
Delete operation of resource: neighbors
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of process-name
ID of address
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of process-name
ID of address
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of process-name
ID of address
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of process-name
ID of address
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of address
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of address
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
AREA-SCOPE - Update
Update operation of resource: area-scope
area-scopebody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Create
Create operation of resource: area-scope
area-scopebody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Delete
Delete operation of resource: area-scope
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Retrieve
Retrieve operation of resource: area-scope
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of address
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of address
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of address
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
SHAM-LINKS - Update
Update operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Create
Create operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Delete
Delete operation of resource: sham-links
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Retrieve
Retrieve operation of resource: sham-links
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
SHAM-LINK - Update
Update operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Create
Create operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Delete
Delete operation of resource: sham-link
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Retrieve
Retrieve operation of resource: sham-link
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
VIRTUAL-LINKS - Update
Update operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Create
Create operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Delete
Delete operation of resource: virtual-links
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Retrieve
Retrieve operation of resource: virtual-links
ID of process-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
VIRTUAL-LINK - Update
Update operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Create
Create operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Delete
Delete operation of resource: virtual-link
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
AREA-AREA-ID - Update
Update operation of resource: area-area-id
area-area-idbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Create
Create operation of resource: area-area-id
area-area-idbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Delete
Delete operation of resource: area-area-id
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Retrieve
Retrieve operation of resource: area-area-id
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
RANGES - Update
Update operation of resource: ranges
rangesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Create
Create operation of resource: ranges
rangesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Delete
Delete operation of resource: ranges
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Retrieve
Retrieve operation of resource: ranges
ID of process-name
ID of area-id
Successful operation
Internal Error
RANGE - Update
Update operation of resource: range
rangebody object
ID of process-name
ID of area-id
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Create
Create operation of resource: range
rangebody object
ID of process-name
ID of area-id
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Delete
Delete operation of resource: range
ID of process-name
ID of area-id
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Retrieve
Retrieve operation of resource: range
ID of process-name
ID of area-id
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
NSSA - Update
Update operation of resource: nssa
nssabody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Create
Create operation of resource: nssa
nssabody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Delete
Delete operation of resource: nssa
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Retrieve
Retrieve operation of resource: nssa
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of area-id
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of area-id
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
NEIGHBORS - Update
Update operation of resource: neighbors
neighborsbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Create
Create operation of resource: neighbors
neighborsbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Delete
Delete operation of resource: neighbors
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of process-name
ID of area-id
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of process-name
ID of area-id
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of process-name
ID of area-id
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of process-name
ID of area-id
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of area-id
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of area-id
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
AREA-SCOPE - Update
Update operation of resource: area-scope
area-scopebody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Create
Create operation of resource: area-scope
area-scopebody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Delete
Delete operation of resource: area-scope
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Retrieve
Retrieve operation of resource: area-scope
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of area-id
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of area-id
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of area-id
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
SHAM-LINKS - Update
Update operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Create
Create operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Delete
Delete operation of resource: sham-links
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Retrieve
Retrieve operation of resource: sham-links
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
SHAM-LINK - Update
Update operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Create
Create operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Delete
Delete operation of resource: sham-link
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Retrieve
Retrieve operation of resource: sham-link
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
VIRTUAL-LINKS - Update
Update operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Create
Create operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Delete
Delete operation of resource: virtual-links
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Retrieve
Retrieve operation of resource: virtual-links
ID of process-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
VIRTUAL-LINK - Update
Update operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Create
Create operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Delete
Delete operation of resource: virtual-link
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
TIMERS - Update
Update operation of resource: timers
timersbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
PACING - Update
Update operation of resource: pacing
pacingbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Create
Create operation of resource: pacing
pacingbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Delete
Delete operation of resource: pacing
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Retrieve
Retrieve operation of resource: pacing
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
LSA-TIMERS - Update
Update operation of resource: lsa-timers
lsa-timersbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"arrival": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Create
Create operation of resource: lsa-timers
lsa-timersbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"arrival": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Delete
Delete operation of resource: lsa-timers
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Retrieve
Retrieve operation of resource: lsa-timers
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"arrival": "integer"
}
THROTTLE - Update
Update operation of resource: throttle
throttlebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Create
Create operation of resource: throttle
throttlebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Delete
Delete operation of resource: throttle
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Retrieve
Retrieve operation of resource: throttle
ID of process-name
Successful operation
Internal Error
LSA - Update
Update operation of resource: lsa
lsabody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Create
Create operation of resource: lsa
lsabody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Delete
Delete operation of resource: lsa
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Retrieve
Retrieve operation of resource: lsa
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mospf": [ null ]
}
SPF - Update
Update operation of resource: spf
spfbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Create
Create operation of resource: spf
spfbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Delete
Delete operation of resource: spf
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Retrieve
Retrieve operation of resource: spf
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
SUMMARY-PREFIXES - Update
Update operation of resource: summary-prefixes
summary-prefixesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Create
Create operation of resource: summary-prefixes
summary-prefixesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Delete
Delete operation of resource: summary-prefixes
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Retrieve
Retrieve operation of resource: summary-prefixes
ID of process-name
Successful operation
Internal Error
SUMMARY-PREFIX - Update
Update operation of resource: summary-prefix
summary-prefixbody object
ID of process-name
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Create
Create operation of resource: summary-prefix
summary-prefixbody object
ID of process-name
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Delete
Delete operation of resource: summary-prefix
ID of process-name
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Retrieve
Retrieve operation of resource: summary-prefix
ID of process-name
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
ID of process-name
Successful operation
Internal Error
TRAP-RATE-LIMIT - Update
Update operation of resource: trap-rate-limit
trap-rate-limitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Create
Create operation of resource: trap-rate-limit
trap-rate-limitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Delete
Delete operation of resource: trap-rate-limit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Retrieve
Retrieve operation of resource: trap-rate-limit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-window-traps": "integer",
"window-size": "integer"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string"
}
TIEBREAKERS - Update
Update operation of resource: tiebreakers
tiebreakersbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Create
Create operation of resource: tiebreakers
tiebreakersbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Delete
Delete operation of resource: tiebreakers
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Retrieve
Retrieve operation of resource: tiebreakers
ID of process-name
Successful operation
Internal Error
TIEBREAKER - Update
Update operation of resource: tiebreaker
tiebreakerbody object
ID of process-name
ID of tiebreaker-type
Request Content-Types: application/json
Request Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Create
Create operation of resource: tiebreaker
tiebreakerbody object
ID of process-name
ID of tiebreaker-type
Request Content-Types: application/json
Request Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Delete
Delete operation of resource: tiebreaker
ID of process-name
ID of tiebreaker-type
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Retrieve
Retrieve operation of resource: tiebreaker
ID of process-name
ID of tiebreaker-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
DISTANCE - Update
Update operation of resource: distance
distancebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Create
Create operation of resource: distance
distancebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Delete
Delete operation of resource: distance
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Retrieve
Retrieve operation of resource: distance
ID of process-name
Successful operation
Internal Error
OSPFV3 - Update
Update operation of resource: ospfv3
ospfv3body object
ID of process-name
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Create
Create operation of resource: ospfv3
ospfv3body object
ID of process-name
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Delete
Delete operation of resource: ospfv3
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of process-name
Successful operation
Internal Error
REDISTRIBUTED-PREFIXES - Update
Update operation of resource: redistributed-prefixes
redistributed-prefixesbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Create
Create operation of resource: redistributed-prefixes
redistributed-prefixesbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Delete
Delete operation of resource: redistributed-prefixes
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Retrieve
Retrieve operation of resource: redistributed-prefixes
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
REDISTRIBUTES - Update
Update operation of resource: redistributes
redistributesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Create
Create operation of resource: redistributes
redistributesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Delete
Delete operation of resource: redistributes
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Retrieve
Retrieve operation of resource: redistributes
ID of process-name
Successful operation
Internal Error
REDISTRIBUTE - Update
Update operation of resource: redistribute
redistributebody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Create
Create operation of resource: redistribute
redistributebody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Delete
Delete operation of resource: redistribute
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Retrieve
Retrieve operation of resource: redistribute
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Update
Update operation of resource: connected-or-static-or-subscriber-or-mobile
connected-or-static-or-subscriber-or-mobilebody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Create
Create operation of resource: connected-or-static-or-subscriber-or-mobile
connected-or-static-or-subscriber-or-mobilebody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Delete
Delete operation of resource: connected-or-static-or-subscriber-or-mobile
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Retrieve
Retrieve operation of resource: connected-or-static-or-subscriber-or-mobile
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
OSPFV3-OR-ISIS-OR-APPLICATION - Update
Update operation of resource: ospfv3-or-isis-or-application
ospfv3-or-isis-or-applicationbody object
ID of process-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Create
Create operation of resource: ospfv3-or-isis-or-application
ospfv3-or-isis-or-applicationbody object
ID of process-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Delete
Delete operation of resource: ospfv3-or-isis-or-application
ID of process-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Retrieve
Retrieve operation of resource: ospfv3-or-isis-or-application
ID of process-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
EIGRP - Update
Update operation of resource: eigrp
eigrpbody object
ID of process-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Create
Create operation of resource: eigrp
eigrpbody object
ID of process-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Delete
Delete operation of resource: eigrp
ID of process-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Retrieve
Retrieve operation of resource: eigrp
ID of process-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
IGNORE - Update
Update operation of resource: ignore
ignorebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Create
Create operation of resource: ignore
ignorebody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Delete
Delete operation of resource: ignore
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Retrieve
Retrieve operation of resource: ignore
ID of process-name
Successful operation
Internal Error
LSA - Update
Update operation of resource: lsa
lsabody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Create
Create operation of resource: lsa
lsabody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Delete
Delete operation of resource: lsa
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Retrieve
Retrieve operation of resource: lsa
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mospf": [ null ]
}
DISTRIBUTE-LIST-OUT - Update
Update operation of resource: distribute-list-out
distribute-list-outbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Create
Create operation of resource: distribute-list-out
distribute-list-outbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Delete
Delete operation of resource: distribute-list-out
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Retrieve
Retrieve operation of resource: distribute-list-out
ID of process-name
Successful operation
Internal Error
DISTRIBUTE-OUTS - Update
Update operation of resource: distribute-outs
distribute-outsbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Create
Create operation of resource: distribute-outs
distribute-outsbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Delete
Delete operation of resource: distribute-outs
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Retrieve
Retrieve operation of resource: distribute-outs
ID of process-name
Successful operation
Internal Error
DISTRIBUTE-OUT - Update
Update operation of resource: distribute-out
distribute-outbody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Create
Create operation of resource: distribute-out
distribute-outbody object
ID of process-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Delete
Delete operation of resource: distribute-out
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Retrieve
Retrieve operation of resource: distribute-out
ID of process-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of process-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
OSPFV3-OR-ISIS - Update
Update operation of resource: ospfv3-or-isis
ospfv3-or-isisbody object
ID of process-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Create
Create operation of resource: ospfv3-or-isis
ospfv3-or-isisbody object
ID of process-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Delete
Delete operation of resource: ospfv3-or-isis
ID of process-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Retrieve
Retrieve operation of resource: ospfv3-or-isis
ID of process-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
EIGRP - Update
Update operation of resource: eigrp
eigrpbody object
ID of process-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Create
Create operation of resource: eigrp
eigrpbody object
ID of process-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Delete
Delete operation of resource: eigrp
ID of process-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Retrieve
Retrieve operation of resource: eigrp
ID of process-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
STUB-ROUTER - Update
Update operation of resource: stub-router
stub-routerbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Create
Create operation of resource: stub-router
stub-routerbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Delete
Delete operation of resource: stub-router
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Retrieve
Retrieve operation of resource: stub-router
ID of process-name
Successful operation
Internal Error
RBIT - Update
Update operation of resource: rbit
rbitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Create
Create operation of resource: rbit
rbitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Delete
Delete operation of resource: rbit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Retrieve
Retrieve operation of resource: rbit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
V6BIT - Update
Update operation of resource: v6bit
v6bitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Create
Create operation of resource: v6bit
v6bitbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Delete
Delete operation of resource: v6bit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Retrieve
Retrieve operation of resource: v6bit
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
MAX-METRIC - Update
Update operation of resource: max-metric
max-metricbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Create
Create operation of resource: max-metric
max-metricbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Delete
Delete operation of resource: max-metric
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Retrieve
Retrieve operation of resource: max-metric
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
CAPABILITY - Update
Update operation of resource: capability
capabilitybody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Create
Create operation of resource: capability
capabilitybody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Delete
Delete operation of resource: capability
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Retrieve
Retrieve operation of resource: capability
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
DEFAULT-INFORMATION - Update
Update operation of resource: default-information
default-informationbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Create
Create operation of resource: default-information
default-informationbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Delete
Delete operation of resource: default-information
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Retrieve
Retrieve operation of resource: default-information
ID of process-name
Successful operation
Internal Error
ORIGINATE - Update
Update operation of resource: originate
originatebody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Create
Create operation of resource: originate
originatebody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Delete
Delete operation of resource: originate
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Retrieve
Retrieve operation of resource: originate
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
PROCESS-SCOPE - Update
Update operation of resource: process-scope
process-scopebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Create
Create operation of resource: process-scope
process-scopebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Delete
Delete operation of resource: process-scope
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Retrieve
Retrieve operation of resource: process-scope
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
AUTO-COST - Update
Update operation of resource: auto-cost
auto-costbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Create
Create operation of resource: auto-cost
auto-costbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Delete
Delete operation of resource: auto-cost
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Retrieve
Retrieve operation of resource: auto-cost
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
ID of process-name
Request Content-Types: application/json
Request Example
{ {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"snmpvrf-trap": [ null ], "domain-id-name": "string",
"domain-id-type": "string"
}, {
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
DOMAIN-ID - Update
Update operation of resource: domain-id
domain-idbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-ID - Create
Create operation of resource: domain-id
domain-idbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-ID - Delete
Delete operation of resource: domain-id
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DOMAIN-ID - Retrieve
Retrieve operation of resource: domain-id
ID of process-name
ID of vrf-name
Successful operation
Internal Error
SECONDARY-DOMAIN-IDS - Update
Update operation of resource: secondary-domain-ids
secondary-domain-idsbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-IDS - Create
Create operation of resource: secondary-domain-ids
secondary-domain-idsbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-IDS - Delete
Delete operation of resource: secondary-domain-ids
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-IDS - Retrieve
Retrieve operation of resource: secondary-domain-ids
ID of process-name
ID of vrf-name
Successful operation
Internal Error
SECONDARY-DOMAIN-ID - Update
Update operation of resource: secondary-domain-id
secondary-domain-idbody object
ID of process-name
ID of vrf-name
ID of domain-id-type domain-id-name
Request Content-Types: application/json
Request Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-ID - Create
Create operation of resource: secondary-domain-id
secondary-domain-idbody object
ID of process-name
ID of vrf-name
ID of domain-id-type domain-id-name
Request Content-Types: application/json
Request Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-ID - Delete
Delete operation of resource: secondary-domain-id
ID of process-name
ID of vrf-name
ID of domain-id-type domain-id-name
Successful operation
Internal Error
Response Content-Types: application/json
SECONDARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: secondary-domain-id
ID of process-name
ID of vrf-name
ID of domain-id-type domain-id-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-name": "string",
"domain-id-type": "string"
}
PRIMARY-DOMAIN-ID - Update
Update operation of resource: primary-domain-id
primary-domain-idbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-DOMAIN-ID - Create
Create operation of resource: primary-domain-id
primary-domain-idbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-DOMAIN-ID - Delete
Delete operation of resource: primary-domain-id
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PRIMARY-DOMAIN-ID - Retrieve
Retrieve operation of resource: primary-domain-id
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"domain-id-name": "string",
"domain-id-type": "string"
}
AREA-ADDRESSES - Update
Update operation of resource: area-addresses
area-addressesbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Create
Create operation of resource: area-addresses
area-addressesbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Delete
Delete operation of resource: area-addresses
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESSES - Retrieve
Retrieve operation of resource: area-addresses
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"area-address": [ null ],
"area-area-id": [ null ]
}
AREA-ADDRESS - Update
Update operation of resource: area-address
area-addressbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Create
Create operation of resource: area-address
area-addressbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Delete
Delete operation of resource: area-address
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AREA-ADDRESS - Retrieve
Retrieve operation of resource: area-address
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
RANGES - Update
Update operation of resource: ranges
rangesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Create
Create operation of resource: ranges
rangesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Delete
Delete operation of resource: ranges
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Retrieve
Retrieve operation of resource: ranges
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
RANGE - Update
Update operation of resource: range
rangebody object
ID of process-name
ID of vrf-name
ID of address
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Create
Create operation of resource: range
rangebody object
ID of process-name
ID of vrf-name
ID of address
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Delete
Delete operation of resource: range
ID of process-name
ID of vrf-name
ID of address
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Retrieve
Retrieve operation of resource: range
ID of process-name
ID of vrf-name
ID of address
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
NSSA - Update
Update operation of resource: nssa
nssabody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Create
Create operation of resource: nssa
nssabody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Delete
Delete operation of resource: nssa
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Retrieve
Retrieve operation of resource: nssa
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
NEIGHBORS - Update
Update operation of resource: neighbors
neighborsbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Create
Create operation of resource: neighbors
neighborsbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Delete
Delete operation of resource: neighbors
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
AREA-SCOPE - Update
Update operation of resource: area-scope
area-scopebody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Create
Create operation of resource: area-scope
area-scopebody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Delete
Delete operation of resource: area-scope
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Retrieve
Retrieve operation of resource: area-scope
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
ID of address
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of address
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of address
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
SHAM-LINKS - Update
Update operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Create
Create operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Delete
Delete operation of resource: sham-links
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Retrieve
Retrieve operation of resource: sham-links
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
SHAM-LINK - Update
Update operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Create
Create operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Delete
Delete operation of resource: sham-link
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Retrieve
Retrieve operation of resource: sham-link
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
VIRTUAL-LINKS - Update
Update operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Create
Create operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of vrf-name
ID of address
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Delete
Delete operation of resource: virtual-links
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Retrieve
Retrieve operation of resource: virtual-links
ID of process-name
ID of vrf-name
ID of address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
VIRTUAL-LINK - Update
Update operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Create
Create operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Delete
Delete operation of resource: virtual-link
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of address
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
AREA-AREA-ID - Update
Update operation of resource: area-area-id
area-area-idbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Create
Create operation of resource: area-area-id
area-area-idbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Delete
Delete operation of resource: area-area-id
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AREA-AREA-ID - Retrieve
Retrieve operation of resource: area-area-id
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
RANGES - Update
Update operation of resource: ranges
rangesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Create
Create operation of resource: ranges
rangesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Delete
Delete operation of resource: ranges
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
RANGES - Retrieve
Retrieve operation of resource: ranges
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
RANGE - Update
Update operation of resource: range
rangebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Create
Create operation of resource: range
rangebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Delete
Delete operation of resource: range
ID of process-name
ID of vrf-name
ID of area-id
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
RANGE - Retrieve
Retrieve operation of resource: range
ID of process-name
ID of vrf-name
ID of area-id
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
NSSA - Update
Update operation of resource: nssa
nssabody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Create
Create operation of resource: nssa
nssabody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Delete
Delete operation of resource: nssa
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
NSSA - Retrieve
Retrieve operation of resource: nssa
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
INTERFACES - Update
Update operation of resource: interfaces
interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Create
Create operation of resource: interfaces
interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Delete
Delete operation of resource: interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACES - Retrieve
Retrieve operation of resource: interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
INTERFACE - Update
Update operation of resource: interface
interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Create
Create operation of resource: interface
interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Delete
Delete operation of resource: interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE - Retrieve
Retrieve operation of resource: interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
NEIGHBORS - Update
Update operation of resource: neighbors
neighborsbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Create
Create operation of resource: neighbors
neighborsbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Delete
Delete operation of resource: neighbors
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBORS - Retrieve
Retrieve operation of resource: neighbors
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
NEIGHBOR - Update
Update operation of resource: neighbor
neighborbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Create
Create operation of resource: neighbor
neighborbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of neighbor-address
Request Content-Types: application/json
Request Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Delete
Delete operation of resource: neighbor
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
NEIGHBOR - Retrieve
Retrieve operation of resource: neighbor
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of neighbor-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
AREA-SCOPE - Update
Update operation of resource: area-scope
area-scopebody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Create
Create operation of resource: area-scope
area-scopebody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Delete
Delete operation of resource: area-scope
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
AREA-SCOPE - Retrieve
Retrieve operation of resource: area-scope
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
ID of area-id
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
ID of area-id
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of area-id
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
SHAM-LINKS - Update
Update operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Create
Create operation of resource: sham-links
sham-linksbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Delete
Delete operation of resource: sham-links
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINKS - Retrieve
Retrieve operation of resource: sham-links
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
SHAM-LINK - Update
Update operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Create
Create operation of resource: sham-link
sham-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Delete
Delete operation of resource: sham-link
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
SHAM-LINK - Retrieve
Retrieve operation of resource: sham-link
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of source-address destination-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
VIRTUAL-LINKS - Update
Update operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Create
Create operation of resource: virtual-links
virtual-linksbody object
ID of process-name
ID of vrf-name
ID of area-id
Request Content-Types: application/json
Request Example
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Delete
Delete operation of resource: virtual-links
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINKS - Retrieve
Retrieve operation of resource: virtual-links
ID of process-name
ID of vrf-name
ID of area-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
VIRTUAL-LINK - Update
Update operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Create
Create operation of resource: virtual-link
virtual-linkbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Delete
Delete operation of resource: virtual-link
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
VIRTUAL-LINK - Retrieve
Retrieve operation of resource: virtual-link
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string", "authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer", "spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
ID of area-id
ID of virtual-link-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
TIMERS - Update
Update operation of resource: timers
timersbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Create
Create operation of resource: timers
timersbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Delete
Delete operation of resource: timers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TIMERS - Retrieve
Retrieve operation of resource: timers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "arrival": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}, "maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}, "flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
PACING - Update
Update operation of resource: pacing
pacingbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Create
Create operation of resource: pacing
pacingbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Delete
Delete operation of resource: pacing
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PACING - Retrieve
Retrieve operation of resource: pacing
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
LSA-TIMERS - Update
Update operation of resource: lsa-timers
lsa-timersbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"arrival": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Create
Create operation of resource: lsa-timers
lsa-timersbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"arrival": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Delete
Delete operation of resource: lsa-timers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA-TIMERS - Retrieve
Retrieve operation of resource: lsa-timers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"arrival": "integer"
}
THROTTLE - Update
Update operation of resource: throttle
throttlebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Create
Create operation of resource: throttle
throttlebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Delete
Delete operation of resource: throttle
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
THROTTLE - Retrieve
Retrieve operation of resource: throttle
ID of process-name
ID of vrf-name
Successful operation
Internal Error
LSA - Update
Update operation of resource: lsa
lsabody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Create
Create operation of resource: lsa
lsabody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Delete
Delete operation of resource: lsa
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Retrieve
Retrieve operation of resource: lsa
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mospf": [ null ]
}
SPF - Update
Update operation of resource: spf
spfbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Create
Create operation of resource: spf
spfbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Delete
Delete operation of resource: spf
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SPF - Retrieve
Retrieve operation of resource: spf
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
SUMMARY-PREFIXES - Update
Update operation of resource: summary-prefixes
summary-prefixesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Create
Create operation of resource: summary-prefixes
summary-prefixesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Delete
Delete operation of resource: summary-prefixes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIXES - Retrieve
Retrieve operation of resource: summary-prefixes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
SUMMARY-PREFIX - Update
Update operation of resource: summary-prefix
summary-prefixbody object
ID of process-name
ID of vrf-name
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Create
Create operation of resource: summary-prefix
summary-prefixbody object
ID of process-name
ID of vrf-name
ID of prefix prefix-length
Request Content-Types: application/json
Request Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Delete
Delete operation of resource: summary-prefix
ID of process-name
ID of vrf-name
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
SUMMARY-PREFIX - Retrieve
Retrieve operation of resource: summary-prefix
ID of process-name
ID of vrf-name
ID of prefix prefix-length
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
ID of process-name
ID of vrf-name
Successful operation
Internal Error
TRAP-RATE-LIMIT - Update
Update operation of resource: trap-rate-limit
trap-rate-limitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Create
Create operation of resource: trap-rate-limit
trap-rate-limitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Delete
Delete operation of resource: trap-rate-limit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-RATE-LIMIT - Retrieve
Retrieve operation of resource: trap-rate-limit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"max-window-traps": "integer",
"window-size": "integer"
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"priority": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priority": "string"
}
TIEBREAKERS - Update
Update operation of resource: tiebreakers
tiebreakersbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Create
Create operation of resource: tiebreakers
tiebreakersbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Delete
Delete operation of resource: tiebreakers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKERS - Retrieve
Retrieve operation of resource: tiebreakers
ID of process-name
ID of vrf-name
Successful operation
Internal Error
TIEBREAKER - Update
Update operation of resource: tiebreaker
tiebreakerbody object
ID of process-name
ID of vrf-name
ID of tiebreaker-type
Request Content-Types: application/json
Request Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Create
Create operation of resource: tiebreaker
tiebreakerbody object
ID of process-name
ID of vrf-name
ID of tiebreaker-type
Request Content-Types: application/json
Request Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Delete
Delete operation of resource: tiebreaker
ID of process-name
ID of vrf-name
ID of tiebreaker-type
Successful operation
Internal Error
Response Content-Types: application/json
TIEBREAKER - Retrieve
Retrieve operation of resource: tiebreaker
ID of process-name
ID of vrf-name
ID of tiebreaker-type
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
DISTANCE - Update
Update operation of resource: distance
distancebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Create
Create operation of resource: distance
distancebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Delete
Delete operation of resource: distance
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTANCE - Retrieve
Retrieve operation of resource: distance
ID of process-name
ID of vrf-name
Successful operation
Internal Error
OSPFV3 - Update
Update operation of resource: ospfv3
ospfv3body object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Create
Create operation of resource: ospfv3
ospfv3body object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Delete
Delete operation of resource: ospfv3
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
MAXIMUM - Update
Update operation of resource: maximum
maximumbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Create
Create operation of resource: maximum
maximumbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Delete
Delete operation of resource: maximum
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAXIMUM - Retrieve
Retrieve operation of resource: maximum
ID of process-name
ID of vrf-name
Successful operation
Internal Error
REDISTRIBUTED-PREFIXES - Update
Update operation of resource: redistributed-prefixes
redistributed-prefixesbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Create
Create operation of resource: redistributed-prefixes
redistributed-prefixesbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Delete
Delete operation of resource: redistributed-prefixes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTED-PREFIXES - Retrieve
Retrieve operation of resource: redistributed-prefixes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
REDISTRIBUTES - Update
Update operation of resource: redistributes
redistributesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Create
Create operation of resource: redistributes
redistributesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Delete
Delete operation of resource: redistributes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTES - Retrieve
Retrieve operation of resource: redistributes
ID of process-name
ID of vrf-name
Successful operation
Internal Error
REDISTRIBUTE - Update
Update operation of resource: redistribute
redistributebody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Create
Create operation of resource: redistribute
redistributebody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Delete
Delete operation of resource: redistribute
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
REDISTRIBUTE - Retrieve
Retrieve operation of resource: redistribute
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Update
Update operation of resource: connected-or-static-or-subscriber-or-mobile
connected-or-static-or-subscriber-or-mobilebody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Create
Create operation of resource: connected-or-static-or-subscriber-or-mobile
connected-or-static-or-subscriber-or-mobilebody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Delete
Delete operation of resource: connected-or-static-or-subscriber-or-mobile
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
CONNECTED-OR-STATIC-OR-SUBSCRIBER-OR-MOBILE - Retrieve
Retrieve operation of resource: connected-or-static-or-subscriber-or-mobile
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
OSPFV3-OR-ISIS-OR-APPLICATION - Update
Update operation of resource: ospfv3-or-isis-or-application
ospfv3-or-isis-or-applicationbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Create
Create operation of resource: ospfv3-or-isis-or-application
ospfv3-or-isis-or-applicationbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Delete
Delete operation of resource: ospfv3-or-isis-or-application
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS-OR-APPLICATION - Retrieve
Retrieve operation of resource: ospfv3-or-isis-or-application
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
EIGRP - Update
Update operation of resource: eigrp
eigrpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Create
Create operation of resource: eigrp
eigrpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Delete
Delete operation of resource: eigrp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Retrieve
Retrieve operation of resource: eigrp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
IGNORE - Update
Update operation of resource: ignore
ignorebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Create
Create operation of resource: ignore
ignorebody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Delete
Delete operation of resource: ignore
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IGNORE - Retrieve
Retrieve operation of resource: ignore
ID of process-name
ID of vrf-name
Successful operation
Internal Error
LSA - Update
Update operation of resource: lsa
lsabody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Create
Create operation of resource: lsa
lsabody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"mospf": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Delete
Delete operation of resource: lsa
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
LSA - Retrieve
Retrieve operation of resource: lsa
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mospf": [ null ]
}
DISTRIBUTE-LIST-OUT - Update
Update operation of resource: distribute-list-out
distribute-list-outbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Create
Create operation of resource: distribute-list-out
distribute-list-outbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Delete
Delete operation of resource: distribute-list-out
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST-OUT - Retrieve
Retrieve operation of resource: distribute-list-out
ID of process-name
ID of vrf-name
Successful operation
Internal Error
DISTRIBUTE-OUTS - Update
Update operation of resource: distribute-outs
distribute-outsbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Create
Create operation of resource: distribute-outs
distribute-outsbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Delete
Delete operation of resource: distribute-outs
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUTS - Retrieve
Retrieve operation of resource: distribute-outs
ID of process-name
ID of vrf-name
Successful operation
Internal Error
DISTRIBUTE-OUT - Update
Update operation of resource: distribute-out
distribute-outbody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Create
Create operation of resource: distribute-out
distribute-outbody object
ID of process-name
ID of vrf-name
ID of protocol-name
Request Content-Types: application/json
Request Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Delete
Delete operation of resource: distribute-out
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-OUT - Retrieve
Retrieve operation of resource: distribute-out
ID of process-name
ID of vrf-name
ID of protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
BGP - Update
Update operation of resource: bgp
bgpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Create
Create operation of resource: bgp
bgpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Delete
Delete operation of resource: bgp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
BGP - Retrieve
Retrieve operation of resource: bgp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx as-yy
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
OSPFV3-OR-ISIS - Update
Update operation of resource: ospfv3-or-isis
ospfv3-or-isisbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Create
Create operation of resource: ospfv3-or-isis
ospfv3-or-isisbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Delete
Delete operation of resource: ospfv3-or-isis
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3-OR-ISIS - Retrieve
Retrieve operation of resource: ospfv3-or-isis
ID of process-name
ID of vrf-name
ID of protocol-name
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
EIGRP - Update
Update operation of resource: eigrp
eigrpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Create
Create operation of resource: eigrp
eigrpbody object
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Delete
Delete operation of resource: eigrp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
EIGRP - Retrieve
Retrieve operation of resource: eigrp
ID of process-name
ID of vrf-name
ID of protocol-name
ID of as-xx
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
DISTRIBUTE-LIST - Update
Update operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Create
Create operation of resource: distribute-list
distribute-listbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Delete
Delete operation of resource: distribute-list
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DISTRIBUTE-LIST - Retrieve
Retrieve operation of resource: distribute-list
ID of process-name
ID of vrf-name
Successful operation
Internal Error
IN - Update
Update operation of resource: in
inbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Create
Create operation of resource: in
inbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"prefix-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
IN - Delete
Delete operation of resource: in
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
IN - Retrieve
Retrieve operation of resource: in
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"prefix-list": "string"
}
STUB-ROUTER - Update
Update operation of resource: stub-router
stub-routerbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Create
Create operation of resource: stub-router
stub-routerbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Delete
Delete operation of resource: stub-router
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
STUB-ROUTER - Retrieve
Retrieve operation of resource: stub-router
ID of process-name
ID of vrf-name
Successful operation
Internal Error
RBIT - Update
Update operation of resource: rbit
rbitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Create
Create operation of resource: rbit
rbitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Delete
Delete operation of resource: rbit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
RBIT - Retrieve
Retrieve operation of resource: rbit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
V6BIT - Update
Update operation of resource: v6bit
v6bitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Create
Create operation of resource: v6bit
v6bitbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Delete
Delete operation of resource: v6bit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
V6BIT - Retrieve
Retrieve operation of resource: v6bit
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
MAX-METRIC - Update
Update operation of resource: max-metric
max-metricbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Create
Create operation of resource: max-metric
max-metricbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"on-proc-restart": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Delete
Delete operation of resource: max-metric
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
MAX-METRIC - Retrieve
Retrieve operation of resource: max-metric
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"on-proc-restart": "integer"
}
ON-STARTUP - Update
Update operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Create
Create operation of resource: on-startup
on-startupbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Delete
Delete operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ON-STARTUP - Retrieve
Retrieve operation of resource: on-startup
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
BFD - Update
Update operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Create
Create operation of resource: bfd
bfdbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Delete
Delete operation of resource: bfd
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
BFD - Retrieve
Retrieve operation of resource: bfd
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
DATABASE-FILTER - Update
Update operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Create
Create operation of resource: database-filter
database-filterbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Delete
Delete operation of resource: database-filter
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DATABASE-FILTER - Retrieve
Retrieve operation of resource: database-filter
ID of process-name
ID of vrf-name
Successful operation
Internal Error
ALL - Update
Update operation of resource: all
allbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Create
Create operation of resource: all
allbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"out": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Delete
Delete operation of resource: all
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ALL - Retrieve
Retrieve operation of resource: all
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"out": [ null ]
}
CAPABILITY - Update
Update operation of resource: capability
capabilitybody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Create
Create operation of resource: capability
capabilitybody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Delete
Delete operation of resource: capability
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CAPABILITY - Retrieve
Retrieve operation of resource: capability
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
AUTHENTICATION - Update
Update operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Create
Create operation of resource: authentication
authenticationbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Delete
Delete operation of resource: authentication
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTHENTICATION - Retrieve
Retrieve operation of resource: authentication
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
GRACEFUL-RESTART - Update
Update operation of resource: graceful-restart
graceful-restartbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Create
Create operation of resource: graceful-restart
graceful-restartbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Delete
Delete operation of resource: graceful-restart
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
GRACEFUL-RESTART - Retrieve
Retrieve operation of resource: graceful-restart
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
DEFAULT-INFORMATION - Update
Update operation of resource: default-information
default-informationbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Create
Create operation of resource: default-information
default-informationbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Delete
Delete operation of resource: default-information
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-INFORMATION - Retrieve
Retrieve operation of resource: default-information
ID of process-name
ID of vrf-name
Successful operation
Internal Error
ORIGINATE - Update
Update operation of resource: originate
originatebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Create
Create operation of resource: originate
originatebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Delete
Delete operation of resource: originate
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ORIGINATE - Retrieve
Retrieve operation of resource: originate
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
PROCESS-SCOPE - Update
Update operation of resource: process-scope
process-scopebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Create
Create operation of resource: process-scope
process-scopebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Delete
Delete operation of resource: process-scope
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PROCESS-SCOPE - Retrieve
Retrieve operation of resource: process-scope
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
FAST-REROUTE - Update
Update operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Create
Create operation of resource: fast-reroute
fast-reroutebody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Delete
Delete operation of resource: fast-reroute
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
FAST-REROUTE - Retrieve
Retrieve operation of resource: fast-reroute
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-name": "string"
}
]
}
}, {
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
PER-LINK - Update
Update operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Create
Create operation of resource: per-link
per-linkbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Delete
Delete operation of resource: per-link
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-LINK - Retrieve
Retrieve operation of resource: per-link
ID of process-name
ID of vrf-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
PER-PREFIX - Update
Update operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Create
Create operation of resource: per-prefix
per-prefixbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Delete
Delete operation of resource: per-prefix
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
PER-PREFIX - Retrieve
Retrieve operation of resource: per-prefix
ID of process-name
ID of vrf-name
CANDIDATE-INTERFACES - Update
Update operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Create
Create operation of resource: candidate-interfaces
candidate-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Delete
Delete operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACES - Retrieve
Retrieve operation of resource: candidate-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
CANDIDATE-INTERFACE - Update
Update operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Create
Create operation of resource: candidate-interface
candidate-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Delete
Delete operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CANDIDATE-INTERFACE - Retrieve
Retrieve operation of resource: candidate-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
EXCLUDE-INTERFACES - Update
Update operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Create
Create operation of resource: exclude-interfaces
exclude-interfacesbody object
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Delete
Delete operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACES - Retrieve
Retrieve operation of resource: exclude-interfaces
ID of process-name
ID of vrf-name
Successful operation
Internal Error
EXCLUDE-INTERFACE - Update
Update operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Create
Create operation of resource: exclude-interface
exclude-interfacebody object
ID of process-name
ID of vrf-name
ID of interface-name
Request Content-Types: application/json
Request Example
{
"interface-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Delete
Delete operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
EXCLUDE-INTERFACE - Retrieve
Retrieve operation of resource: exclude-interface
ID of process-name
ID of vrf-name
ID of interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-name": "string"
}
ENCRYPTION - Update
Update operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Create
Create operation of resource: encryption
encryptionbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Delete
Delete operation of resource: encryption
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTION - Retrieve
Retrieve operation of resource: encryption
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
AUTO-COST - Update
Update operation of resource: auto-cost
auto-costbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Create
Create operation of resource: auto-cost
auto-costbody object
ID of process-name
ID of vrf-name
Request Content-Types: application/json
Request Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Delete
Delete operation of resource: auto-cost
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
AUTO-COST - Retrieve
Retrieve operation of resource: auto-cost
ID of process-name
ID of vrf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
AF - Update
Update operation of resource: af
afbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Create
Create operation of resource: af
afbody object
ID of process-name
Request Content-Types: application/json
Request Example
{
"af-name": "string",
"saf-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AF - Delete
Delete operation of resource: af
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
AF - Retrieve
Retrieve operation of resource: af
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"saf-name": "string"
}
TRACE-BUFS - Update
Update operation of resource: trace-bufs
trace-bufsbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUFS - Create
Create operation of resource: trace-bufs
trace-bufsbody object
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUFS - Delete
Delete operation of resource: trace-bufs
ID of process-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUFS - Retrieve
Retrieve operation of resource: trace-bufs
ID of process-name
Successful operation
Internal Error
TRACE-BUF - Update
Update operation of resource: trace-buf
trace-bufbody object
ID of process-name
ID of trace-buf-name
Request Content-Types: application/json
Request Example
{
"trace-buf-name": "string",
"bufsize": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUF - Create
Create operation of resource: trace-buf
trace-bufbody object
ID of process-name
ID of trace-buf-name
Request Content-Types: application/json
Request Example
{
"trace-buf-name": "string",
"bufsize": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUF - Delete
Delete operation of resource: trace-buf
ID of process-name
ID of trace-buf-name
Successful operation
Internal Error
Response Content-Types: application/json
TRACE-BUF - Retrieve
Retrieve operation of resource: trace-buf
ID of process-name
ID of trace-buf-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"trace-buf-name": "string",
"bufsize": "string"
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
OSPFV3 - Update
Update operation of resource: ospfv3
ospfv3body object
Request Content-Types: application/json
Request Example
{ "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Create
Create operation of resource: ospfv3
ospfv3body object
Request Content-Types: application/json
Request Example
{ "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Delete
Delete operation of resource: ospfv3
Successful operation
Internal Error
Response Content-Types: application/json
OSPFV3 - Retrieve
Retrieve operation of resource: ospfv3
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}, "virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
ERROR - Update
Update operation of resource: error
errorbody object
Request Content-Types: application/json
Request Example
{
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ERROR - Create
Create operation of resource: error
errorbody object
Request Content-Types: application/json
Request Example
{
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
ERROR - Delete
Delete operation of resource: error
Successful operation
Internal Error
Response Content-Types: application/json
ERROR - Retrieve
Retrieve operation of resource: error
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
STATE-CHANGE - Update
Update operation of resource: state-change
state-changebody object
Request Content-Types: application/json
Request Example
{
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATE-CHANGE - Create
Create operation of resource: state-change
state-changebody object
Request Content-Types: application/json
Request Example
{
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
STATE-CHANGE - Delete
Delete operation of resource: state-change
Successful operation
Internal Error
Response Content-Types: application/json
STATE-CHANGE - Retrieve
Retrieve operation of resource: state-change
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
Schema Definitions
DEAD-INTERVAL:
Common node of default-vrf, vrf
- dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second"
Example
{
"dead-interval": "integer"
}
DEFAULT-METRIC:
Common node of default-vrf, vrf
- default-metric: integer
-
Set metric of redistributed routes
range:"1..16777214" default:metric"
Example
{
"default-metric": "integer"
}
NETWORK:
Common node of default-vrf, vrf
- network: string broadcast, non-broadcast, point-to-point, point-to-multipoint, non-broadcast-point-to-multipoint
-
Specify network type
Example
{
"network": "string"
}
FAST-REROUTE-USE-CANDIDATE-ONLY:
Common node of per-link, per-prefix
- fast-reroute-use-candidate-only: boolean
-
Use only interfaces on the candidate list as a backup path
default: false
Example
{
"fast-reroute-use-candidate-only": "boolean"
}
DEMAND-CIRCUIT:
Common node of default-vrf, vrf
- demand-circuit: boolean
-
Enable/disable demand circuit operation
default:
Example
{
"demand-circuit": "boolean"
}
COST:
Common node of default-vrf, vrf
- cost: integer
-
Interface cost
range:"1..65535"
Example
{
"cost": "integer"
}
LOG-ADJACENCY-CHANGES:
Common node of default-vrf, vrf
- log-adjacency-changes: string suppress, brief, detail
-
Log changes in adjacency state
Example
{
"log-adjacency-changes": "string"
}
DATABASE-FILTER:
Common node of default-vrf, vrf
- database-filter: object
-
Database filter
-
- all: object
-
All
-
- out: null
-
Enable out
Example
{
"database-filter": {
"all": {
"out": [ null ]
}
}
}
DEFAULT-INFORMATION:
Common node of default-vrf, vrf
- default-information: object
-
Control distribution of default information
-
- originate: object
-
Distribute a default route
-
- always: boolean
-
Always advertise default route
- metric: integer
-
OSPFv3 default metric
range:"0..16777214" default:metric" - tag: integer
-
Tag for default route
range:"1..4294967295" default:route" - metric-type: integer
-
OSPFv3 metric type for default routes
range:"1..2" default:routes" - route-policy-name: string
-
Route policy to default-information origination
Example
{
"default-information": {
"originate": {
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
}
}
AREA-TABLE:
Common node of default-vrf, vrf
- area-addresses: object
-
Area configuration
-
- area-address: object[]
-
Configuration for a particular area
-
- address: string
-
Area ID if in IP address format
- area-area-id: object[]
-
Configuration for a particular area
-
- area-id: integer
-
Area ID if in integer format
range:"0..4294967295"
Example
{
"area-addresses": {
"area-address": [
{
"address": "string"
}
],
"area-area-id": [
{
"area-id": "integer"
}
]
}
}
DISTRIBUTE-LIST:
Common node of default-vrf, vrfCommon node of default-vrf, vrf
- distribute-list: object
-
Filter prefixes to/from RIB
-
- in: object
-
Filter prefixes installed to RIB
-
- prefix-list: string
-
Filter prefixes based on an IPv6 prefix-list
Example
{
"distribute-list": {
"in": {
"prefix-list": "string"
}
}
}
RETRANSMIT-INTERVAL:
Common node of default-vrf, vrf
- retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second"
Example
{
"retransmit-interval": "integer"
}
HELLO-INTERVAL:
Common node of default-vrf, vrf
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second"
Example
{
"hello-interval": "integer"
}
ON-STARTUP:
Common node of rbit, v6bit, max-metric
- on-startup: object
-
Enter stub router operational state on startup
-
- wait-for-bgp: boolean
-
Wait until BGP converges (only applicable to default VRF)
default: false - wait-time: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"on-startup": {
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
}
ROUTER-ID:
Common node of default-vrf, vrf
- router-id: string
-
Specify the router ID for this OSPFv3 process in IPv4 address format
Example
{
"router-id": "string"
}
STUB-ROUTER:
Common node of default-vrf, vrf
- stub-router: object
-
Stub router configuration
-
- v6bit: ON-PROC-RESTART
-
Stub router V6-bit configuration
- max-metric:
-
Stub router max-metric configuration
- rbit: ON-PROC-RESTART
-
Stub router R-bit configuration
Example
{
"stub-router": {
"v6bit": {
"on-proc-restart": "integer"
},
"max-metric": {
"external-lsa": "integer",
"summary-lsa": "integer",
"on-proc-restart": "integer"
},
"rbit": {
"on-proc-restart": "integer"
}
}
}
BFD:
Common node of default-vrf, vrf
- bfd: object
-
Configure BFD parameters
-
- fast-detect-mode: string disable, default, strict
-
Enable or disable BFD fast detection
- interval: integer
-
Hello interval in milli-seconds
units:"millisecond" - detection-multiplier: integer
-
Detect multiplier
range:"2..50"
Example
{
"bfd": {
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
}
IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE:
Common node of default-vrf, vrfCommon node of process-scope, area-scope, interface
- fast-reroute: object
-
Fast-reroute configuration
-
- per-link: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- per-prefix: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- fast-reroute-enable: string none, per-link, per-prefix
-
Enable/Disable Fast-reroute per-link or per-prefix
Example
{
"fast-reroute": {
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
CAPABILITY:
Common node of vrf, default-vrf
- capability: object
-
OSPFv3 Capability
-
- vrf-lite: boolean
-
Enable VRF Lite
default: - type7-translate-zero-forwarding-addr: boolean
-
Enable capability to translate LSAs with fwd addr
default: - type7-prefer: boolean
-
NSSA capability to prefer Type 7 over Type 5
default:
Example
{
"capability": {
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
}
PROCESS-SCOPE:
Common node of default-vrf, vrf
- process-scope: IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE
-
Process scope configuration
Example
{
"process-scope": {
"fast-reroute": {
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
}
REDISTRIBUTE-TABLE:
Common node of default-vrf, vrf
- redistributes: object
-
Redistribute information from another routing protocol
-
- redistribute: object[]
-
Redistribute information from another routing protocol
-
object - bgp: object[]
-
bgp
-
- as-xx: integer
-
4-byte AS number in asdot (X.Y) format - first half (X)
range:"1..65535" - as-yy: integer
-
4-byte AS number in asdot (X.Y) format - second half (Y), or 2-byte AS number, or 4-byte AS number in asplain format
range:"0..4294967295"
- ospfv3-or-isis-or-application: object[]
-
ospfv3 or isis or application
-
- process-name: string
-
ISIS process name if protocol is ISIS, or OSPFv3 process name if protocol is OSPFv3
- eigrp: object[]
-
eigrp
-
- as-xx: integer
-
4-byte AS number in asdot (X.Y) format - first half (X)
range:"1..65535"
- protocol-name: string connected, static, bgp, isis, ospfv3, eigrp, subscriber, application, mobile
-
Protocol
- connected-or-static-or-subscriber-or-mobile: REDISTRIBUTE-CONTENT
-
connected or static or subscriber or mobile
Example
{
"redistributes": {
"redistribute": [
{
"bgp": [
{
"as-xx": "integer",
"as-yy": "integer"
}
],
"ospfv3-or-isis-or-application": [
{
"process-name": "string"
}
],
"eigrp": [
{
"as-xx": "integer"
}
],
"protocol-name": "string"
}
]
}
}
PRIORITY:
Common node of per-link, per-prefix
- priority: string critical, high, medium, low
-
Fast-reroute per-link/per-prefix priority-limit command
Example
{
"priority": "string"
}
TIMERS:
Common node of default-vrf, vrf
- timers: object
-
Adjust routing timers
-
- lsa-timers: object
-
LSA timers
-
- arrival: integer
-
The minimum interval in milliseconds between accepting the same LSA
range:"0..60000" units:"millisecond"
- throttle: object
-
Throttle timers
-
- spf: object
-
SPF throttle timers
-
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
- lsa: object
-
LSA throttle timers for all types of OSPF LSAs
-
- maximum-delay: integer
-
Maximum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - first-delay: integer
-
Delay to generate first occurrence of LSA in milliseconds
range:"1..600000" units:"millisecond"
- pacing: object
-
Pacing timers
-
- flood: integer
-
The minimum interval in milliseconds to pace limit flooding on interface
range:"5..100" units:"millisecond" - retransmission: integer
-
The minimum interval in msec between neighbor retransmissions
range:"5..100" - lsa-group: integer
-
Interval in seconds at which LSAs are grouped and refreshed, checksummed, or aged
range:"10..1800" units:"second"
Example
{
"timers": {
"lsa-timers": {
"arrival": "integer"
},
"throttle": {
"spf": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
},
"lsa": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
},
"pacing": {
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
}
FLOOD-REDUCTION:
Common node of default-vrf, vrf
- flood-reduction: boolean
-
Enable/disable flood reduction
default:
Example
{
"flood-reduction": "boolean"
}
MTU-IGNORE:
Common node of default-vrf, vrf
- mtu-ignore: boolean
-
Enable/disable ignoring of MTU in DBD packets
default:
Example
{
"mtu-ignore": "boolean"
}
ON-PROC-MIGRATION:
Common node of rbit, v6bit, max-metric
- on-proc-migration: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"on-proc-migration": "integer"
}
ON-PROC-RESTART:
Common node of rbit, v6bit, max-metric
- on-proc-restart: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"on-proc-restart": "integer"
}
TRANSMIT-DELAY:
Common node of default-vrf, vrf
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second"
Example
{
"transmit-delay": "integer"
}
FAST-REROUTE:
Common node of default-vrf, vrf
- fast-reroute: object
-
Fast-reroute instance scoped parameters
-
- per-link: PRIORITY
-
Fast-reroute per-link global configuration
- per-prefix:
-
Fast-reroute per-prefix global configuration
Example
{
"fast-reroute": {
"per-link": {
"priority": "string"
},
"per-prefix": {
"load-sharing-disable": [ null ],
"tiebreakers": {
"tiebreaker": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
]
},
"priority": "string"
}
}
}
AUTO-COST:
Common node of default-vrf, vrf
- auto-cost: object
-
Calculate interface cost according to bandwidth
-
- reference-bandwidth: integer
-
Specify reference bandwidth for cost computations in terms of Mbits per second
range:"1..4294967" units:"Mbit/s" - disable: null
-
Specify 'true' to assign cost based on interface type
Example
{
"auto-cost": {
"reference-bandwidth": "integer",
"disable": [ null ]
}
}
MAXIMUM:
Common node of default-vrf, vrf
- maximum: object
-
Set OSPFv3 limits
-
- redistributed-prefixes: object
-
Limit number of redistributed prefixes
-
- prefixes: integer
-
Maximum number of prefixes redistributed to protocol
range:"1..4294967295" - threshold: integer
-
Threshold value (%) at which to generate a warning message
range:"0..100000" units:"second" default:"50000" - warning-only: null
-
Only give warning message when limit is exceeded
- interfaces: integer
-
Specify maximum number of interfaces
range:"1..4294967295" - paths: integer
-
Specify maximum number of paths per route
range:"1..64"
Example
{
"maximum": {
"redistributed-prefixes": {
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
},
"interfaces": "integer",
"paths": "integer"
}
}
PASSIVE:
Common node of default-vrf, vrf
- passive: boolean
-
Enable/disable routing updates on an interface
default:
Example
{
"passive": "boolean"
}
IPV6-OSPFV3-CFG-PRIORITY:
Common node of per-link, per-prefixCommon node of default-vrf, vrf
- priority: integer
-
Specify router priority
range:"0..255"
Example
{
"priority": "integer"
}
PACKET-SIZE:
Common node of default-vrf, vrf
- packet-size: integer
-
Limit size of OSPFv3 packets
range:"484..65500"
Example
{
"packet-size": "integer"
}
SUMMARY-PREFIX-TABLE:
Common node of default-vrf, vrf
- summary-prefixes: object
-
Summarize redistributed routes matching prefix/length
-
- summary-prefix: object[]
-
IPv6 address
-
object - prefix: string
-
IPv6 prefix string format
- tag: integer
-
Tag
range:"1..4294967295" default:route" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Suppress routes matching prefix/length
Example
{
"summary-prefixes": {
"summary-prefix": [
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
]
}
}
GRACEFUL-RESTART:
Common node of default-vrf, vrf
- graceful-restart: object
-
Graceful restart configuration
-
- enable: null
-
Enable graceful restart
- strict-lsa-checking: null
-
Terminate graceful restart helper mode if LSA changed
- interval: integer
-
Minimum interval between graceful restarts (seconds)
units:"millisecond" - helper: null
-
Disable router's helper support
- lifetime: integer
-
Maximum route lifetime following restart (seconds)
range:"90..1800" units:"second"
Example
{
"graceful-restart": {
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
}
SPF-PREFIX-PRIORITY-POLICY:
Common node of default-vrf, vrf
- spf-prefix-priority-policy: string
-
Route policy for SPF prefix prioritization
Example
{
"spf-prefix-priority-policy": "string"
}
DISTANCE:
Common node of default-vrf, vrf
- distance: object
-
Define an administrative distance
-
- administrative: integer
-
Define an administrative distance
range:"1..255" - ospfv3: object
-
OSPFv3 administrative distance
-
- intra-area: integer
-
Distance for intra-area routes
range:"1..255" - external: integer
-
Distance for external type 5 and type 7 routes
range:"1..255" - inter-area: integer
-
Distance for inter-area routes
range:"1..255"
Example
{
"distance": {
"administrative": "integer",
"ospfv3": {
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
}
}
ALWAYS:
Common node of rbit, v6bit, max-metric
- always: null
-
Unconditionally enter stub router operational state
Example
{
"always": [ null ]
}
DISTRIBUTE-LIST-OUT:
Common node of default-vrf, vrf
- distribute-list-out: object
-
Filter prefixes from RIB
-
- distribute-outs: object
-
Filter generated type-5 LSAs
-
- distribute-out: object[]
-
Filter generated type-5 LSAs
-
object - bgp: object[]
-
bgp
-
- as-xx: integer
-
4-byte AS number in asdot (X.Y) format - first half (X)
range:"1..65535" - as-yy: integer
-
4-byte AS number in asdot (X.Y) format - second half (Y), or 2-byte AS number, or 4-byte AS number in asplain format
range:"0..4294967295"
- eigrp: object[]
-
eigrp
-
- as-xx: integer
-
4-byte AS number in asdot (X.Y) format - first half (X)
range:"1..65535"
- ospfv3-or-isis: object[]
-
ospfv3 or isis
-
- process-name: string
-
If ISIS or OSPFv3, specify the instance name
- protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"distribute-list-out": {
"distribute-outs": {
"distribute-out": [
{
"bgp": [
{
"as-xx": "integer",
"as-yy": "integer"
}
],
"eigrp": [
{
"as-xx": "integer"
}
],
"ospfv3-or-isis": [
{
"process-name": "string"
}
],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
]
}
}
}
SNMP:
Common node of default-vrf, vrf
- snmp: object
-
SNMP configuration
-
- trap-rate-limit: object
-
SNMP trap rate configuration
-
- max-window-traps: integer
-
Max number of traps sent in window time
range:"0..300" - window-size: integer
-
Trap rate limit sliding window size
range:"2..60"
- context: string
-
SNMP context configuration
Example
{
"snmp": {
"trap-rate-limit": {
"max-window-traps": "integer",
"window-size": "integer"
},
"context": "string"
}
}
INCLUDE-STUB:
Common node of rbit, max-metric
- include-stub: null
-
Advertise stub links with maximum metric in stub router mode
Example
{
"include-stub": [ null ]
}
IGNORE:
Common node of default-vrf, vrf
- ignore: object
-
Do not complain about a specified event
-
- lsa: object
-
Do not complain upon receiving LSA of the specified type
-
- mospf: null
-
Enable ignore of MOSPF type 6 LSA
Example
{
"ignore": {
"lsa": {
"mospf": [ null ]
}
}
}
INSTANCE:
Common node of default-vrf, vrf
- instance: integer
-
Instance ID
range:"0..255"
Example
{
"instance": "integer"
}
AUTHENTICATION:
Common node of default-vrf, vrf
- authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
default: - algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
CANDIDATE-INTERFACE-TABLE:
Common node of per-link, per-prefix
- candidate-interfaces: object
-
Fast-reroute per-link/per-prefix candidate interface configuration
-
- candidate-interface: object[]
-
Candidate backup interface
-
object - interface-name: string
-
Interface
Example
{
"candidate-interfaces": {
"candidate-interface": [
{
"interface-name": "string"
}
]
}
}
EXCLUDE-INTERFACE-TABLE:
Common node of per-link, per-prefix
- exclude-interfaces: object
-
Fast-reroute per-link/per-prefix exclude interface configuration
-
- exclude-interface: object[]
-
Exclude an interface from becoming a backup
-
object - interface-name: string
-
Interface
Example
{
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
}
ENCRYPTION:
Common node of default-vrf, vrf
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
default: - authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
Example
{
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
}
ON-SWITCHOVER:
Common node of rbit, v6bit, max-metric
- on-switchover: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"on-switchover": "integer"
}
ospfv3_schema:
OSPFv3 administrative distance
- intra-area: integer
-
Distance for intra-area routes
range:"1..255" - external: integer
-
Distance for external type 5 and type 7 routes
range:"1..255" - inter-area: integer
-
Distance for inter-area routes
range:"1..255"
Example
{
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
processes_schema:
OSPFv3 processes
- process: object[]
-
An OSPFv3 process
-
object - default-vrf:
-
Default VRF related configuration
- vrfs: object
-
VRF related configuration
-
- vrf: object[]
-
Configuration for a particular OSPF VRF
-
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
- vrf-name: string
-
Name for this VRF
- af: object
-
Address Family (AF)
-
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
- trace-bufs: object
-
Configuration to change size of trace buffer
-
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
- protocol-shutdown: null
-
Enable protocol shutdown
- process-name: string
-
OSPFv3 process name
- nsr: string true, false
-
Enable non-stop routing
Example
{
"process": [
{
"default-vrf": {
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
},
"vrfs": {
"vrf": [
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
},
"af": {
"af-name": "string",
"saf-name": "string"
},
"trace-bufs": {
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
]
}
process_schema:
- default-vrf:
-
Default VRF related configuration
- vrfs: object
-
VRF related configuration
-
- vrf: object[]
-
Configuration for a particular OSPF VRF
-
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
- vrf-name: string
-
Name for this VRF
- af: object
-
Address Family (AF)
-
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
- trace-bufs: object
-
Configuration to change size of trace buffer
-
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
- protocol-shutdown: null
-
Enable protocol shutdown
- process-name: string
-
OSPFv3 process name
- nsr: string true, false
-
Enable non-stop routing
Example
{
"default-vrf": {
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
},
"vrfs": {
"vrf": [
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
},
"af": {
"af-name": "string",
"saf-name": "string"
},
"trace-bufs": {
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
default-vrf_schema:
Default VRF related configuration
- ldp-sync: boolean
-
Enable/Disable MPLS LDP sync
default: - spf-prefix-priority-disable: null
-
SPF prefix prioritization disabled
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
default:
Example
{
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}
area-addresses_schema:
Area configuration
- area-address: AREA-CONTENT
-
Configuration for a particular area
-
AREA-CONTENT - area-area-id: AREA-CONTENT
-
Configuration for a particular area
-
AREA-CONTENT
Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
authentication_schema:
Authenticate OSPFv3 packets
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
default: - algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
bfd_schema:
Configure BFD parameters
- fast-detect-mode: string disable, default, strict
-
Enable or disable BFD fast detection
- interval: integer
-
Hello interval in milli-seconds
units:"millisecond" - detection-multiplier: integer
-
Detect multiplier
range:"2..50"
Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
ranges_schema:
Range configuration
- range: object[]
-
Summarize inter-area routes matching prefix/length
-
object - prefix: string
-
IPv6 prefix format
- cost: integer
-
Specified metric for this range
range:"1..65535" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Do not advertise address range
Example
{
"range": [
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
]
}
range_schema:
- prefix: string
-
IPv6 prefix format
- cost: integer
-
Specified metric for this range
range:"1..65535" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Do not advertise address range
default: false
Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
encryption_schema:
Encrypt and authenticate OSPFv3 packets
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
default: - authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
nssa_schema:
Specify area as a NSSA area. Allowed only in non-backbone areas
- metric: integer
-
Only valid with DefaultInfoOriginate
range:"0..16777214" default:metric" - default-info-originate: boolean
-
Originate Type 7 default into NSSA area
default: false - no-summary: null
-
Do not send summary LSA into NSSA
- metric-type: string type1, type2
-
Only valid with DefaultInfoOriginate
- no-redistribution: boolean
-
No redistribution into this NSSA area
default: false
Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
database-filter_schema:
Database filter
- all: object
-
All
-
- out: null
-
Enable out
Example
{
"all": {
"out": [ null ]
}
}
distribute-list_schema:
Filter prefixes to/from RIB
- in: object
-
Filter prefixes installed to RIB
-
- prefix-list: string
-
Filter prefixes based on an IPv6 prefix-list
Example
{
"in": {
"prefix-list": "string"
}
}
in_schema:
Filter prefixes installed to RIB
- prefix-list: string
-
Filter prefixes based on an IPv6 prefix-list
Example
{
"prefix-list": "string"
}
interfaces_schema:
OSPFv3 interfaces
- interface: IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE
-
OSPFv3 interface
-
IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE
Example
{
"interface": [
{
"fast-reroute": {
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
neighbors_schema:
Specify a neighbor router
- neighbor: object[]
-
IPv6 address
-
object - priority: integer
-
OSPFv3 priority of non-broadcast neighbor
range:"0..255" - neighbor-address: string
-
IPV6 address
- cost: integer
-
OSPFv3 cost for point-to-multipoint neighbor
range:"1..65535" - zone: string
-
Zone
- database-filter: boolean
-
Filter OSPFv3 LSA during synchronization and flooding for point-to-multipoint neighbor
- poll-interval: integer
-
OSPFv3 dead-router polling interval (in seconds)
range:"1..20000" units:"second"
Example
{
"neighbor": [
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
]
}
neighbor_schema:
- priority: integer
-
OSPFv3 priority of non-broadcast neighbor
range:"0..255" - neighbor-address: string
-
IPV6 address
- cost: integer
-
OSPFv3 cost for point-to-multipoint neighbor
range:"1..65535" - zone: string
-
Zone
- database-filter: boolean
-
Filter OSPFv3 LSA during synchronization and flooding for point-to-multipoint neighbor
default: - poll-interval: integer
-
OSPFv3 dead-router polling interval (in seconds)
range:"1..20000" units:"second"
Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
fast-reroute_schema:
Fast-reroute configuration
- per-link: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- per-prefix: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- fast-reroute-enable: string none, per-link, per-prefix
-
Enable/Disable Fast-reroute per-link or per-prefix
Example
{
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
candidate-interfaces_schema:
Fast-reroute per-link/per-prefix candidate interface configuration
- candidate-interface: object[]
-
Candidate backup interface
-
object - interface-name: string
-
Interface
Example
{
"candidate-interface": [
{
"interface-name": "string"
}
]
}
exclude-interfaces_schema:
Fast-reroute per-link/per-prefix exclude interface configuration
- exclude-interface: object[]
-
Exclude an interface from becoming a backup
-
object - interface-name: string
-
Interface
Example
{
"exclude-interface": [
{
"interface-name": "string"
}
]
}
sham-links_schema:
Sham Link sub-mode
- sham-link: object[]
-
ShamLink local and remote endpoints
-
object - dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enable sham link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - source-address: string
-
Local sham-link endpoint
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
- destination-address: string
-
Remote sham-link endpoint
Example
{
"sham-link": [
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
sham-link_schema:
- dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enable sham link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - source-address: string
-
Local sham-link endpoint
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
- destination-address: string
-
Remote sham-link endpoint
Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
virtual-links_schema:
Virtual link sub-mode
- virtual-link: object[]
-
Router ID of virtual link neighbor
-
object - dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enabled virtual link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - virtual-link-address: string
-
Router ID of virtual link neighbor
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"virtual-link": [
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
virtual-link_schema:
- dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enabled virtual link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - virtual-link-address: string
-
Router ID of virtual link neighbor
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
timers_schema:
Adjust routing timers
- lsa-timers: object
-
LSA timers
-
- arrival: integer
-
The minimum interval in milliseconds between accepting the same LSA
range:"0..60000" units:"millisecond"
- throttle: object
-
Throttle timers
-
- spf: object
-
SPF throttle timers
-
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
- lsa: object
-
LSA throttle timers for all types of OSPF LSAs
-
- maximum-delay: integer
-
Maximum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - first-delay: integer
-
Delay to generate first occurrence of LSA in milliseconds
range:"1..600000" units:"millisecond"
- pacing: object
-
Pacing timers
-
- flood: integer
-
The minimum interval in milliseconds to pace limit flooding on interface
range:"5..100" units:"millisecond" - retransmission: integer
-
The minimum interval in msec between neighbor retransmissions
range:"5..100" - lsa-group: integer
-
Interval in seconds at which LSAs are grouped and refreshed, checksummed, or aged
range:"10..1800" units:"second"
Example
{
"lsa-timers": {
"arrival": "integer"
},
"throttle": {
"spf": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
},
"lsa": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
},
"pacing": {
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
pacing_schema:
Pacing timers
- flood: integer
-
The minimum interval in milliseconds to pace limit flooding on interface
range:"5..100" units:"millisecond" - retransmission: integer
-
The minimum interval in msec between neighbor retransmissions
range:"5..100" - lsa-group: integer
-
Interval in seconds at which LSAs are grouped and refreshed, checksummed, or aged
range:"10..1800" units:"second"
Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
lsa-timers_schema:
LSA timers
- arrival: integer
-
The minimum interval in milliseconds between accepting the same LSA
range:"0..60000" units:"millisecond"
Example
{
"arrival": "integer"
}
throttle_schema:
Throttle timers
- spf: object
-
SPF throttle timers
-
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
- lsa: object
-
LSA throttle timers for all types of OSPF LSAs
-
- maximum-delay: integer
-
Maximum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - first-delay: integer
-
Delay to generate first occurrence of LSA in milliseconds
range:"1..600000" units:"millisecond"
Example
{
"spf": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
},
"lsa": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}
lsa_schema:
Do not complain upon receiving LSA of the specified type
- mospf: null
-
Enable ignore of MOSPF type 6 LSA
Example
{
"mospf": [ null ]
}
spf_schema:
SPF throttle timers
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
summary-prefixes_schema:
Summarize redistributed routes matching prefix/length
- summary-prefix: object[]
-
IPv6 address
-
object - prefix: string
-
IPv6 prefix string format
- tag: integer
-
Tag
range:"1..4294967295" default:route" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Suppress routes matching prefix/length
Example
{
"summary-prefix": [
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
]
}
summary-prefix_schema:
- prefix: string
-
IPv6 prefix string format
- tag: integer
-
Tag
range:"1..4294967295" default:route" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Suppress routes matching prefix/length
default:
Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
snmp_schema:
SNMP configuration
- trap-rate-limit: object
-
SNMP trap rate configuration
-
- max-window-traps: integer
-
Max number of traps sent in window time
range:"0..300" - window-size: integer
-
Trap rate limit sliding window size
range:"2..60"
- context: string
-
SNMP context configuration
Example
{
"trap-rate-limit": {
"max-window-traps": "integer",
"window-size": "integer"
},
"context": "string"
}
trap-rate-limit_schema:
SNMP trap rate configuration
- max-window-traps: integer
-
Max number of traps sent in window time
range:"0..300" - window-size: integer
-
Trap rate limit sliding window size
range:"2..60"
Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
tiebreakers_schema:
Fast-reroute tiebreakers configurations
- tiebreaker: object[]
-
Fast-reroute tiebreakers configuration
-
object - tiebreaker-type: string downstream, line-card-disjoint, lowest-metric, node-protect, primary-path, secondary-path, srlg-disjoint
-
Tiebreaker type
- tiebreaker-index: integer
-
Index value for a tiebreaker
range:"1..255"
Example
{
"tiebreaker": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
]
}
tiebreaker_schema:
- tiebreaker-type: string downstream, line-card-disjoint, lowest-metric, node-protect, primary-path, secondary-path, srlg-disjoint
-
Tiebreaker type
- tiebreaker-index: integer
-
Index value for a tiebreaker
range:"1..255"
Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
distance_schema:
Define an administrative distance
- administrative: integer
-
Define an administrative distance
range:"1..255" - ospfv3: object
-
OSPFv3 administrative distance
-
- intra-area: integer
-
Distance for intra-area routes
range:"1..255" - external: integer
-
Distance for external type 5 and type 7 routes
range:"1..255" - inter-area: integer
-
Distance for inter-area routes
range:"1..255"
Example
{
"administrative": "integer",
"ospfv3": {
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
}
maximum_schema:
Set OSPFv3 limits
- redistributed-prefixes: object
-
Limit number of redistributed prefixes
-
- prefixes: integer
-
Maximum number of prefixes redistributed to protocol
range:"1..4294967295" - threshold: integer
-
Threshold value (%) at which to generate a warning message
range:"0..100000" units:"second" default:"50000" - warning-only: null
-
Only give warning message when limit is exceeded
- interfaces: integer
-
Specify maximum number of interfaces
range:"1..4294967295" - paths: integer
-
Specify maximum number of paths per route
range:"1..64"
Example
{
"redistributed-prefixes": {
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
},
"interfaces": "integer",
"paths": "integer"
}
redistributed-prefixes_schema:
Limit number of redistributed prefixes
- prefixes: integer
-
Maximum number of prefixes redistributed to protocol
range:"1..4294967295" - threshold: integer
-
Threshold value (%) at which to generate a warning message
range:"0..100000" units:"second" default:"50000" - warning-only: null
-
Only give warning message when limit is exceeded
Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
redistributes_schema:
Redistribute information from another routing protocol
- redistribute: object[]
-
Redistribute information from another routing protocol
-
object - bgp: REDISTRIBUTE-CONTENT
-
bgp
-
REDISTRIBUTE-CONTENT - ospfv3-or-isis-or-application: REDISTRIBUTE-CONTENT
-
ospfv3 or isis or application
-
REDISTRIBUTE-CONTENT - eigrp: REDISTRIBUTE-CONTENT
-
eigrp
-
REDISTRIBUTE-CONTENT - protocol-name: string connected, static, bgp, isis, ospfv3, eigrp, subscriber, application, mobile
-
Protocol
- connected-or-static-or-subscriber-or-mobile: REDISTRIBUTE-CONTENT
-
connected or static or subscriber or mobile
Example
{
"redistribute": [
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
]
}
redistribute_schema:
- bgp: REDISTRIBUTE-CONTENT
-
bgp
-
REDISTRIBUTE-CONTENT - ospfv3-or-isis-or-application: REDISTRIBUTE-CONTENT
-
ospfv3 or isis or application
-
REDISTRIBUTE-CONTENT - eigrp: REDISTRIBUTE-CONTENT
-
eigrp
-
REDISTRIBUTE-CONTENT - protocol-name: string connected, static, bgp, isis, ospfv3, eigrp, subscriber, application, mobile
-
Protocol
- connected-or-static-or-subscriber-or-mobile: REDISTRIBUTE-CONTENT
-
connected or static or subscriber or mobile
Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
ignore_schema:
Do not complain about a specified event
- lsa: object
-
Do not complain upon receiving LSA of the specified type
-
- mospf: null
-
Enable ignore of MOSPF type 6 LSA
Example
{
"lsa": {
"mospf": [ null ]
}
}
distribute-list-out_schema:
Filter prefixes from RIB
- distribute-outs: object
-
Filter generated type-5 LSAs
-
- distribute-out: object[]
-
Filter generated type-5 LSAs
-
object - bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"distribute-outs": {
"distribute-out": [
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
]
}
}
distribute-outs_schema:
Filter generated type-5 LSAs
- distribute-out: object[]
-
Filter generated type-5 LSAs
-
object - bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"distribute-out": [
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
]
}
distribute-out_schema:
- bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
stub-router_schema:
Stub router configuration
- v6bit: ON-PROC-RESTART
-
Stub router V6-bit configuration
- max-metric: ON-PROC-RESTART
-
Stub router max-metric configuration
- rbit: ON-PROC-RESTART
-
Stub router R-bit configuration
Example
{
"v6bit": {
"on-proc-restart": "integer"
},
"max-metric": {
"on-proc-restart": "integer"
},
"rbit": {
"on-proc-restart": "integer"
}
}
on-startup_schema:
Enter stub router operational state on startup
- wait-for-bgp: boolean
-
Wait until BGP converges (only applicable to default VRF)
default: false - wait-time: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
capability_schema:
OSPFv3 Capability
- vrf-lite: boolean
-
Enable VRF Lite
default: - type7-translate-zero-forwarding-addr: boolean
-
Enable capability to translate LSAs with fwd addr
default: - type7-prefer: boolean
-
NSSA capability to prefer Type 7 over Type 5
default:
Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
graceful-restart_schema:
Graceful restart configuration
- enable: null
-
Enable graceful restart
- strict-lsa-checking: null
-
Terminate graceful restart helper mode if LSA changed
- interval: integer
-
Minimum interval between graceful restarts (seconds)
units:"millisecond" - helper: null
-
Disable router's helper support
- lifetime: integer
-
Maximum route lifetime following restart (seconds)
range:"90..1800" units:"second"
Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
default-information_schema:
Control distribution of default information
- originate: object
-
Distribute a default route
-
- always: boolean
-
Always advertise default route
- metric: integer
-
OSPFv3 default metric
range:"0..16777214" default:metric" - tag: integer
-
Tag for default route
range:"1..4294967295" default:route" - metric-type: integer
-
OSPFv3 metric type for default routes
range:"1..2" default:routes" - route-policy-name: string
-
Route policy to default-information origination
Example
{
"originate": {
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
}
originate_schema:
Distribute a default route
- always: boolean
-
Always advertise default route
default: - metric: integer
-
OSPFv3 default metric
range:"0..16777214" default:metric" - tag: integer
-
Tag for default route
range:"1..4294967295" default:route" - metric-type: integer
-
OSPFv3 metric type for default routes
range:"1..2" default:routes" - route-policy-name: string
-
Route policy to default-information origination
Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
auto-cost_schema:
Calculate interface cost according to bandwidth
- reference-bandwidth: integer
-
Specify reference bandwidth for cost computations in terms of Mbits per second
range:"1..4294967" units:"Mbit/s" - disable: null
-
Specify 'true' to assign cost based on interface type
Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
vrfs_schema:
VRF related configuration
- vrf: object[]
-
Configuration for a particular OSPF VRF
-
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
- vrf-name: string
-
Name for this VRF
Example
{
"vrf": [
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
}
vrf_schema:
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
default: - vrf-name: string
-
Name for this VRF
Example
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
domain-id_schema:
OSPFv3 Domain ID
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
}
secondary-domain-ids_schema:
Secondary domain ID Table
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
secondary-domain-id_schema:
- domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
primary-domain-id_schema:
OSPF Primary domain ID
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
af_schema:
Address Family (AF)
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
Example
{
"af-name": "string",
"saf-name": "string"
}
trace-bufs_schema:
Configuration to change size of trace buffer
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
Example
{
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
}
trace-buf_schema:
- trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
Example
{
"trace-buf-name": "string",
"bufsize": "string"
}
a1_ospfv3_schema:
OSPFv3-MIB notification configuration
- state-change: object
-
SNMP notifications for OSPF state change
-
- nssa-translator: null
-
Enable ospfv3NssaTranslatorStatusChange notification
- virtual-neighbor: null
-
Enable ospfv3VirtNbrStateChange notification
- virtual-interface: null
-
Enable ospfv3VirtIfStateChange notification
- neighbor: null
-
Enable ospfv3NbrStateChange notification
- interface: null
-
Enable ospfv3IfStateChange notification
- restart-virtual-helper: null
-
Enable ospfv3VirtNbrRestartHelperStatusChange notification
- restart-helper: null
-
Enable ospfv3NbrRestartHelperStatusChange notification
- restart: null
-
Enable ospfv3RestartStatusChange notification
- error: object
-
SNMP notifications for OSPF errors
-
- virtual-bad-packet: null
-
Enable ospfv3VirtIfRxBadPacket notification
- config-error: null
-
Enable ospfv3IfConfigError notification
- bad-packet: null
-
Enable ospfv3IfRxBadPacket notification
- virtual-config-error: null
-
Enable ospfv3VirtIfConfigError notification
Example
{
"state-change": {
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
},
"error": {
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
a1_processes_schema:
OSPFv3 processes
- process: object[]
-
An OSPFv3 process
-
object - default-vrf:
-
Default VRF related configuration
- vrfs: object
-
VRF related configuration
-
- vrf: object[]
-
Configuration for a particular OSPF VRF
-
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
- vrf-name: string
-
Name for this VRF
- af: object
-
Address Family (AF)
-
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
- trace-bufs: object
-
Configuration to change size of trace buffer
-
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
- protocol-shutdown: null
-
Enable protocol shutdown
- process-name: string
-
OSPFv3 process name
- nsr: string true, false
-
Enable non-stop routing
Example
{
"process": [
{
"default-vrf": {
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
},
"vrfs": {
"vrf": [
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
},
"af": {
"af-name": "string",
"saf-name": "string"
},
"trace-bufs": {
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
]
}
a1_process_schema:
- default-vrf:
-
Default VRF related configuration
- vrfs: object
-
VRF related configuration
-
- vrf: object[]
-
Configuration for a particular OSPF VRF
-
- snmpvrf-trap: null
-
Enable SNMP trap configuration in a VRF
- domain-id: object
-
OSPFv3 Domain ID
-
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
- vrf-name: string
-
Name for this VRF
- af: object
-
Address Family (AF)
-
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
- trace-bufs: object
-
Configuration to change size of trace buffer
-
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
- protocol-shutdown: null
-
Enable protocol shutdown
- process-name: string
-
OSPFv3 process name
- nsr: string true, false
-
Enable non-stop routing
Example
{
"default-vrf": {
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
},
"vrfs": {
"vrf": [
{
"snmpvrf-trap": [ null ],
"domain-id": {
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
},
"prefix-suppression": "boolean",
"vrf-name": "string",
"transmit-delay": "integer"
}
]
},
"af": {
"af-name": "string",
"saf-name": "string"
},
"trace-bufs": {
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
},
"protocol-shutdown": [ null ],
"process-name": "string",
"nsr": "string"
}
a1_default-vrf_schema:
Default VRF related configuration
- ldp-sync: boolean
-
Enable/Disable MPLS LDP sync
- spf-prefix-priority-disable: null
-
SPF prefix prioritization disabled
- prefix-suppression: boolean
-
Enable/disable prefix suppression on an interface
Example
{
"ldp-sync": "boolean",
"spf-prefix-priority-disable": [ null ],
"prefix-suppression": "boolean",
"transmit-delay": "integer"
}
a1_area-addresses_schema:
Area configuration
- area-address: AREA-CONTENT
-
Configuration for a particular area
-
AREA-CONTENT - area-area-id: AREA-CONTENT
-
Configuration for a particular area
-
AREA-CONTENT
Example
{
"area-address": [ null ],
"area-area-id": [ null ]
}
a1_authentication_schema:
Authenticate OSPFv3 packets
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
a1_bfd_schema:
Configure BFD parameters
- fast-detect-mode: string disable, default, strict
-
Enable or disable BFD fast detection
- interval: integer
-
Hello interval in milli-seconds
units:"millisecond" - detection-multiplier: integer
-
Detect multiplier
range:"2..50"
Example
{
"fast-detect-mode": "string",
"interval": "integer",
"detection-multiplier": "integer"
}
a1_ranges_schema:
Range configuration
- range: object[]
-
Summarize inter-area routes matching prefix/length
-
object - prefix: string
-
IPv6 prefix format
- cost: integer
-
Specified metric for this range
range:"1..65535" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Do not advertise address range
Example
{
"range": [
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
]
}
a1_range_schema:
- prefix: string
-
IPv6 prefix format
- cost: integer
-
Specified metric for this range
range:"1..65535" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Do not advertise address range
Example
{
"prefix": "string",
"cost": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
a1_encryption_schema:
Encrypt and authenticate OSPFv3 packets
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
Example
{
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
}
a1_nssa_schema:
Specify area as a NSSA area. Allowed only in non-backbone areas
- metric: integer
-
Only valid with DefaultInfoOriginate
range:"0..16777214" default:metric" - default-info-originate: boolean
-
Originate Type 7 default into NSSA area
- no-summary: null
-
Do not send summary LSA into NSSA
- metric-type: string type1, type2
-
Only valid with DefaultInfoOriginate
- no-redistribution: boolean
-
No redistribution into this NSSA area
Example
{
"metric": "integer",
"default-info-originate": "boolean",
"no-summary": [ null ],
"metric-type": "string",
"no-redistribution": "boolean"
}
a1_database-filter_schema:
Database filter
- all: object
-
All
-
- out: null
-
Enable out
Example
{
"all": {
"out": [ null ]
}
}
a1_distribute-list_schema:
Filter prefixes to/from RIB
- in: object
-
Filter prefixes installed to RIB
-
- prefix-list: string
-
Filter prefixes based on an IPv6 prefix-list
Example
{
"in": {
"prefix-list": "string"
}
}
a1_in_schema:
Filter prefixes installed to RIB
- prefix-list: string
-
Filter prefixes based on an IPv6 prefix-list
Example
{
"prefix-list": "string"
}
a1_interfaces_schema:
OSPFv3 interfaces
- interface: IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE
-
OSPFv3 interface
-
IPV6-OSPFV3-INTFOBJ-CFG-FAST-REROUTE
Example
{
"interface": [
{
"fast-reroute": {
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
}
]
}
a1_neighbors_schema:
Specify a neighbor router
- neighbor: object[]
-
IPv6 address
-
object - priority: integer
-
OSPFv3 priority of non-broadcast neighbor
range:"0..255" - neighbor-address: string
-
IPV6 address
- cost: integer
-
OSPFv3 cost for point-to-multipoint neighbor
range:"1..65535" - zone: string
-
Zone
- database-filter: boolean
-
Filter OSPFv3 LSA during synchronization and flooding for point-to-multipoint neighbor
- poll-interval: integer
-
OSPFv3 dead-router polling interval (in seconds)
range:"1..20000" units:"second"
Example
{
"neighbor": [
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
]
}
a1_neighbor_schema:
- priority: integer
-
OSPFv3 priority of non-broadcast neighbor
range:"0..255" - neighbor-address: string
-
IPV6 address
- cost: integer
-
OSPFv3 cost for point-to-multipoint neighbor
range:"1..65535" - zone: string
-
Zone
- database-filter: boolean
-
Filter OSPFv3 LSA during synchronization and flooding for point-to-multipoint neighbor
- poll-interval: integer
-
OSPFv3 dead-router polling interval (in seconds)
range:"1..20000" units:"second"
Example
{
"priority": "integer",
"neighbor-address": "string",
"cost": "integer",
"zone": "string",
"database-filter": "boolean",
"poll-interval": "integer"
}
a1_fast-reroute_schema:
Fast-reroute configuration
- per-link: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- per-prefix: EXCLUDE-INTERFACE-TABLE
-
Fast-reroute per-link configuration
- fast-reroute-enable: string none, per-link, per-prefix
-
Enable/Disable Fast-reroute per-link or per-prefix
Example
{
"per-link": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"per-prefix": {
"exclude-interfaces": {
"exclude-interface": [
{
"interface-name": "string"
}
]
}
},
"fast-reroute-enable": "string"
}
a1_candidate-interfaces_schema:
Fast-reroute per-link/per-prefix candidate interface configuration
- candidate-interface: object[]
-
Candidate backup interface
-
object - interface-name: string
-
Interface
Example
{
"candidate-interface": [
{
"interface-name": "string"
}
]
}
a1_candidate-interface_schema:
- interface-name: string
-
Interface
Example
{
"interface-name": "string"
}
a1_exclude-interfaces_schema:
Fast-reroute per-link/per-prefix exclude interface configuration
- exclude-interface: object[]
-
Exclude an interface from becoming a backup
-
object - interface-name: string
-
Interface
Example
{
"exclude-interface": [
{
"interface-name": "string"
}
]
}
a1_exclude-interface_schema:
- interface-name: string
-
Interface
Example
{
"interface-name": "string"
}
a1_sham-links_schema:
Sham Link sub-mode
- sham-link: object[]
-
ShamLink local and remote endpoints
-
object - dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enable sham link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - source-address: string
-
Local sham-link endpoint
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
- destination-address: string
-
Remote sham-link endpoint
Example
{
"sham-link": [
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
]
}
a1_sham-link_schema:
- dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enable sham link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - source-address: string
-
Local sham-link endpoint
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
- destination-address: string
-
Remote sham-link endpoint
Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"source-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
},
"destination-address": "string"
}
a1_virtual-links_schema:
Virtual link sub-mode
- virtual-link: object[]
-
Router ID of virtual link neighbor
-
object - dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enabled virtual link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - virtual-link-address: string
-
Router ID of virtual link neighbor
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"virtual-link": [
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
]
}
a1_virtual-link_schema:
- dead-interval: integer
-
Interval after which a neighbor is declared dead (in seconds)
range:"1..65535" units:"second" - enable: null
-
Enabled virtual link
- hello-interval: integer
-
Time between HELLO packets
range:"1..65535" units:"second" - virtual-link-address: string
-
Router ID of virtual link neighbor
- encryption: object
-
Encrypt and authenticate OSPFv3 packets
-
- authentication-algorithm: string null, md5, sha1
-
Use the NULL, MD5 or SHA1 algorithm
- enable: boolean
-
Authenticate packets
- authentication-password: string
-
Specify MD5 or SHA1 password
- spi: integer
-
Use IPSec ESP authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - encryption-algorithm: string null, des, 3des, aes, aes192, aes256
-
Specify the encryption algorithm
- encryption-password: string
-
Encryption password
- transmit-delay: integer
-
Specify the transmit delay in seconds
range:"1..65535" units:"second" - retransmit-interval: integer
-
Specify the transmit interval in seconds
range:"1..65535" units:"second" - authentication: object
-
Authenticate OSPFv3 packets
-
- spi: integer
-
Use IPSec AH authentication. Specify the Security Parameter Index (SPI) value
range:"256..4294967295" - password: string
-
Specify MD5 or SHA1 password
- enable: boolean
-
Authenticate packets
- algorithm: string md5, sha1
-
Use the MD5 or SHA1 algorithm
Example
{
"dead-interval": "integer",
"enable": [ null ],
"hello-interval": "integer",
"virtual-link-address": "string",
"encryption": {
"authentication-algorithm": "string",
"enable": "boolean",
"authentication-password": "string",
"spi": "integer",
"encryption-algorithm": "string",
"encryption-password": "string"
},
"transmit-delay": "integer",
"retransmit-interval": "integer",
"authentication": {
"spi": "integer",
"password": "string",
"enable": "boolean",
"algorithm": "string"
}
}
a1_timers_schema:
Adjust routing timers
- lsa-timers: object
-
LSA timers
-
- arrival: integer
-
The minimum interval in milliseconds between accepting the same LSA
range:"0..60000" units:"millisecond"
- throttle: object
-
Throttle timers
-
- spf: object
-
SPF throttle timers
-
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
- lsa: object
-
LSA throttle timers for all types of OSPF LSAs
-
- maximum-delay: integer
-
Maximum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - first-delay: integer
-
Delay to generate first occurrence of LSA in milliseconds
range:"1..600000" units:"millisecond"
- pacing: object
-
Pacing timers
-
- flood: integer
-
The minimum interval in milliseconds to pace limit flooding on interface
range:"5..100" units:"millisecond" - retransmission: integer
-
The minimum interval in msec between neighbor retransmissions
range:"5..100" - lsa-group: integer
-
Interval in seconds at which LSAs are grouped and refreshed, checksummed, or aged
range:"10..1800" units:"second"
Example
{
"lsa-timers": {
"arrival": "integer"
},
"throttle": {
"spf": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
},
"lsa": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
},
"pacing": {
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
}
a1_pacing_schema:
Pacing timers
- flood: integer
-
The minimum interval in milliseconds to pace limit flooding on interface
range:"5..100" units:"millisecond" - retransmission: integer
-
The minimum interval in msec between neighbor retransmissions
range:"5..100" - lsa-group: integer
-
Interval in seconds at which LSAs are grouped and refreshed, checksummed, or aged
range:"10..1800" units:"second"
Example
{
"flood": "integer",
"retransmission": "integer",
"lsa-group": "integer"
}
a1_lsa-timers_schema:
LSA timers
- arrival: integer
-
The minimum interval in milliseconds between accepting the same LSA
range:"0..60000" units:"millisecond"
Example
{
"arrival": "integer"
}
a1_throttle_schema:
Throttle timers
- spf: object
-
SPF throttle timers
-
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
- lsa: object
-
LSA throttle timers for all types of OSPF LSAs
-
- maximum-delay: integer
-
Maximum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum delay between originating the same LSA in milliseconds
range:"1..600000" units:"millisecond" - first-delay: integer
-
Delay to generate first occurrence of LSA in milliseconds
range:"1..600000" units:"millisecond"
Example
{
"spf": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
},
"lsa": {
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
}
a1_lsa_schema:
Do not complain upon receiving LSA of the specified type
- mospf: null
-
Enable ignore of MOSPF type 6 LSA
Example
{
"mospf": [ null ]
}
a1_spf_schema:
SPF throttle timers
- maximum-delay: integer
-
Maximum wait time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - minimum-delay: integer
-
Minimum hold time between consecutive SPF calculations in ms
range:"1..600000" units:"millisecond" - first-delay: integer
-
Initial delay between receiving a change and starting SPF in ms
range:"1..600000" units:"millisecond"
Example
{
"maximum-delay": "integer",
"minimum-delay": "integer",
"first-delay": "integer"
}
a1_summary-prefixes_schema:
Summarize redistributed routes matching prefix/length
- summary-prefix: object[]
-
IPv6 address
-
object - prefix: string
-
IPv6 prefix string format
- tag: integer
-
Tag
range:"1..4294967295" default:route" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Suppress routes matching prefix/length
Example
{
"summary-prefix": [
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
]
}
a1_summary-prefix_schema:
- prefix: string
-
IPv6 prefix string format
- tag: integer
-
Tag
range:"1..4294967295" default:route" - prefix-length: string
-
IPV6 prefix length
- not-advertise: boolean
-
Suppress routes matching prefix/length
Example
{
"prefix": "string",
"tag": "integer",
"prefix-length": "string",
"not-advertise": "boolean"
}
a1_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a1_trap-rate-limit_schema:
SNMP trap rate configuration
- max-window-traps: integer
-
Max number of traps sent in window time
range:"0..300" - window-size: integer
-
Trap rate limit sliding window size
range:"2..60"
Example
{
"max-window-traps": "integer",
"window-size": "integer"
}
a1_tiebreakers_schema:
Fast-reroute tiebreakers configurations
- tiebreaker: object[]
-
Fast-reroute tiebreakers configuration
-
object - tiebreaker-type: string downstream, line-card-disjoint, lowest-metric, node-protect, primary-path, secondary-path, srlg-disjoint
-
Tiebreaker type
- tiebreaker-index: integer
-
Index value for a tiebreaker
range:"1..255"
Example
{
"tiebreaker": [
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
]
}
a1_tiebreaker_schema:
- tiebreaker-type: string downstream, line-card-disjoint, lowest-metric, node-protect, primary-path, secondary-path, srlg-disjoint
-
Tiebreaker type
- tiebreaker-index: integer
-
Index value for a tiebreaker
range:"1..255"
Example
{
"tiebreaker-type": "string",
"tiebreaker-index": "integer"
}
a1_distance_schema:
Define an administrative distance
- administrative: integer
-
Define an administrative distance
range:"1..255" - ospfv3: object
-
OSPFv3 administrative distance
-
- intra-area: integer
-
Distance for intra-area routes
range:"1..255" - external: integer
-
Distance for external type 5 and type 7 routes
range:"1..255" - inter-area: integer
-
Distance for inter-area routes
range:"1..255"
Example
{
"administrative": "integer",
"ospfv3": {
"intra-area": "integer",
"external": "integer",
"inter-area": "integer"
}
}
a1_maximum_schema:
Set OSPFv3 limits
- redistributed-prefixes: object
-
Limit number of redistributed prefixes
-
- prefixes: integer
-
Maximum number of prefixes redistributed to protocol
range:"1..4294967295" - threshold: integer
-
Threshold value (%) at which to generate a warning message
range:"0..100000" units:"second" default:"50000" - warning-only: null
-
Only give warning message when limit is exceeded
- interfaces: integer
-
Specify maximum number of interfaces
range:"1..4294967295" - paths: integer
-
Specify maximum number of paths per route
range:"1..64"
Example
{
"redistributed-prefixes": {
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
},
"interfaces": "integer",
"paths": "integer"
}
a1_redistributed-prefixes_schema:
Limit number of redistributed prefixes
- prefixes: integer
-
Maximum number of prefixes redistributed to protocol
range:"1..4294967295" - threshold: integer
-
Threshold value (%) at which to generate a warning message
range:"0..100000" units:"second" default:"50000" - warning-only: null
-
Only give warning message when limit is exceeded
Example
{
"prefixes": "integer",
"threshold": "integer",
"warning-only": [ null ]
}
a1_redistributes_schema:
Redistribute information from another routing protocol
- redistribute: object[]
-
Redistribute information from another routing protocol
-
object - bgp: REDISTRIBUTE-CONTENT
-
bgp
-
REDISTRIBUTE-CONTENT - ospfv3-or-isis-or-application: REDISTRIBUTE-CONTENT
-
ospfv3 or isis or application
-
REDISTRIBUTE-CONTENT - eigrp: REDISTRIBUTE-CONTENT
-
eigrp
-
REDISTRIBUTE-CONTENT - protocol-name: string connected, static, bgp, isis, ospfv3, eigrp, subscriber, application, mobile
-
Protocol
- connected-or-static-or-subscriber-or-mobile: REDISTRIBUTE-CONTENT
-
connected or static or subscriber or mobile
Example
{
"redistribute": [
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
]
}
a1_redistribute_schema:
- bgp: REDISTRIBUTE-CONTENT
-
bgp
-
REDISTRIBUTE-CONTENT - ospfv3-or-isis-or-application: REDISTRIBUTE-CONTENT
-
ospfv3 or isis or application
-
REDISTRIBUTE-CONTENT - eigrp: REDISTRIBUTE-CONTENT
-
eigrp
-
REDISTRIBUTE-CONTENT - protocol-name: string connected, static, bgp, isis, ospfv3, eigrp, subscriber, application, mobile
-
Protocol
- connected-or-static-or-subscriber-or-mobile: REDISTRIBUTE-CONTENT
-
connected or static or subscriber or mobile
Example
{
"bgp": [ null ],
"ospfv3-or-isis-or-application": [ null ],
"eigrp": [ null ],
"protocol-name": "string"
}
a1_ignore_schema:
Do not complain about a specified event
- lsa: object
-
Do not complain upon receiving LSA of the specified type
-
- mospf: null
-
Enable ignore of MOSPF type 6 LSA
Example
{
"lsa": {
"mospf": [ null ]
}
}
a1_distribute-list-out_schema:
Filter prefixes from RIB
- distribute-outs: object
-
Filter generated type-5 LSAs
-
- distribute-out: object[]
-
Filter generated type-5 LSAs
-
object - bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"distribute-outs": {
"distribute-out": [
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
]
}
}
a1_distribute-outs_schema:
Filter generated type-5 LSAs
- distribute-out: object[]
-
Filter generated type-5 LSAs
-
object - bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"distribute-out": [
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
]
}
a1_distribute-out_schema:
- bgp: DISTRIBUTE-OUT-CONTENT
-
bgp
-
DISTRIBUTE-OUT-CONTENT - eigrp: DISTRIBUTE-OUT-CONTENT
-
eigrp
-
DISTRIBUTE-OUT-CONTENT - ospfv3-or-isis: DISTRIBUTE-OUT-CONTENT
-
ospfv3 or isis
-
DISTRIBUTE-OUT-CONTENT - protocol-name: string all, connected, static, bgp, isis, ospfv3, eigrp
-
none
- all-or-connected-or-static-prefix-list: string
-
Prefix-list name
Example
{
"bgp": [ null ],
"eigrp": [ null ],
"ospfv3-or-isis": [ null ],
"protocol-name": "string",
"all-or-connected-or-static-prefix-list": "string"
}
a1_stub-router_schema:
Stub router configuration
- v6bit: ON-PROC-RESTART
-
Stub router V6-bit configuration
- max-metric: ON-PROC-RESTART
-
Stub router max-metric configuration
- rbit: ON-PROC-RESTART
-
Stub router R-bit configuration
Example
{
"v6bit": {
"on-proc-restart": "integer"
},
"max-metric": {
"on-proc-restart": "integer"
},
"rbit": {
"on-proc-restart": "integer"
}
}
a1_on-startup_schema:
Enter stub router operational state on startup
- wait-for-bgp: boolean
-
Wait until BGP converges (only applicable to default VRF)
- wait-time: integer
-
Time (in seconds) to stay in stub router operational state
range:"5..86400" units:"second"
Example
{
"wait-for-bgp": "boolean",
"wait-time": "integer"
}
a1_capability_schema:
OSPFv3 Capability
- vrf-lite: boolean
-
Enable VRF Lite
- type7-translate-zero-forwarding-addr: boolean
-
Enable capability to translate LSAs with fwd addr
- type7-prefer: boolean
-
NSSA capability to prefer Type 7 over Type 5
Example
{
"vrf-lite": "boolean",
"type7-translate-zero-forwarding-addr": "boolean",
"type7-prefer": "boolean"
}
a1_graceful-restart_schema:
Graceful restart configuration
- enable: null
-
Enable graceful restart
- strict-lsa-checking: null
-
Terminate graceful restart helper mode if LSA changed
- interval: integer
-
Minimum interval between graceful restarts (seconds)
units:"millisecond" - helper: null
-
Disable router's helper support
- lifetime: integer
-
Maximum route lifetime following restart (seconds)
range:"90..1800" units:"second"
Example
{
"enable": [ null ],
"strict-lsa-checking": [ null ],
"interval": "integer",
"helper": [ null ],
"lifetime": "integer"
}
a1_default-information_schema:
Control distribution of default information
- originate: object
-
Distribute a default route
-
- always: boolean
-
Always advertise default route
- metric: integer
-
OSPFv3 default metric
range:"0..16777214" default:metric" - tag: integer
-
Tag for default route
range:"1..4294967295" default:route" - metric-type: integer
-
OSPFv3 metric type for default routes
range:"1..2" default:routes" - route-policy-name: string
-
Route policy to default-information origination
Example
{
"originate": {
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
}
a1_originate_schema:
Distribute a default route
- always: boolean
-
Always advertise default route
- metric: integer
-
OSPFv3 default metric
range:"0..16777214" default:metric" - tag: integer
-
Tag for default route
range:"1..4294967295" default:route" - metric-type: integer
-
OSPFv3 metric type for default routes
range:"1..2" default:routes" - route-policy-name: string
-
Route policy to default-information origination
Example
{
"always": "boolean",
"metric": "integer",
"tag": "integer",
"metric-type": "integer",
"route-policy-name": "string"
}
a1_auto-cost_schema:
Calculate interface cost according to bandwidth
- reference-bandwidth: integer
-
Specify reference bandwidth for cost computations in terms of Mbits per second
range:"1..4294967" units:"Mbit/s" - disable: null
-
Specify 'true' to assign cost based on interface type
Example
{
"reference-bandwidth": "integer",
"disable": [ null ]
}
a1_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a1_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a1_domain-id_schema:
OSPFv3 Domain ID
- primary-domain-id: object
-
OSPF Primary domain ID
-
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
- secondary-domain-ids: object
-
Secondary domain ID Table
-
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"primary-domain-id": {
"domain-id-name": "string",
"domain-id-type": "string"
},
"secondary-domain-ids": {
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
}
a1_secondary-domain-ids_schema:
Secondary domain ID Table
- secondary-domain-id: object[]
-
OSPF Secondary domain ID
-
object - domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"secondary-domain-id": [
{
"domain-id-name": "string",
"domain-id-type": "string"
}
]
}
a1_secondary-domain-id_schema:
- domain-id-name: string
-
Secondary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Secondary domain ID type
Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
a1_primary-domain-id_schema:
OSPF Primary domain ID
- domain-id-name: string
-
Primary domain ID value
- domain-id-type: string type0005, type0105, type0205, type8005
-
Primary domain ID type
Example
{
"domain-id-name": "string",
"domain-id-type": "string"
}
a1_af_schema:
Address Family (AF)
- af-name: string ipv6
-
Address Family (AF) identifier
- saf-name: string unicast
-
Subsequent Address Family (SAF) identifier
Example
{
"af-name": "string",
"saf-name": "string"
}
a1_trace-bufs_schema:
Configuration to change size of trace buffer
- trace-buf: object[]
-
Changes the size of the specified trace buffer
-
object - trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
Example
{
"trace-buf": [
{
"trace-buf-name": "string",
"bufsize": "string"
}
]
}
a1_trace-buf_schema:
- trace-buf-name: string
-
Name for this trace buffer
- bufsize: string size0, size256, size512, size1024, size2048, size4096, size8192, size16384, size32768, size65536
-
Buffer size
Example
{
"trace-buf-name": "string",
"bufsize": "string"
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a1_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a1_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a1_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a1_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a1_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a1_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a1_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a1_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a1_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a1_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a1_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a1_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a1_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a1_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a1_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a1_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a1_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a1_notification_schema:
Enable SNMP notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
- ospfv3: object
-
OSPFv3-MIB notification configuration
-
- state-change: object
-
SNMP notifications for OSPF state change
-
- nssa-translator: null
-
Enable ospfv3NssaTranslatorStatusChange notification
- virtual-neighbor: null
-
Enable ospfv3VirtNbrStateChange notification
- virtual-interface: null
-
Enable ospfv3VirtIfStateChange notification
- neighbor: null
-
Enable ospfv3NbrStateChange notification
- interface: null
-
Enable ospfv3IfStateChange notification
- restart-virtual-helper: null
-
Enable ospfv3VirtNbrRestartHelperStatusChange notification
- restart-helper: null
-
Enable ospfv3NbrRestartHelperStatusChange notification
- restart: null
-
Enable ospfv3RestartStatusChange notification
- error: object
-
SNMP notifications for OSPF errors
-
- virtual-bad-packet: null
-
Enable ospfv3VirtIfRxBadPacket notification
- config-error: null
-
Enable ospfv3IfConfigError notification
- bad-packet: null
-
Enable ospfv3IfRxBadPacket notification
- virtual-config-error: null
-
Enable ospfv3VirtIfConfigError notification
Example
{
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
},
"ospfv3": {
"state-change": {
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
},
"error": {
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
}
}
a1_error_schema:
SNMP notifications for OSPF errors
- virtual-bad-packet: null
-
Enable ospfv3VirtIfRxBadPacket notification
- config-error: null
-
Enable ospfv3IfConfigError notification
- bad-packet: null
-
Enable ospfv3IfRxBadPacket notification
- virtual-config-error: null
-
Enable ospfv3VirtIfConfigError notification
Example
{
"virtual-bad-packet": [ null ],
"config-error": [ null ],
"bad-packet": [ null ],
"virtual-config-error": [ null ]
}
a1_state-change_schema:
SNMP notifications for OSPF state change
- nssa-translator: null
-
Enable ospfv3NssaTranslatorStatusChange notification
- virtual-neighbor: null
-
Enable ospfv3VirtNbrStateChange notification
- virtual-interface: null
-
Enable ospfv3VirtIfStateChange notification
- neighbor: null
-
Enable ospfv3NbrStateChange notification
- interface: null
-
Enable ospfv3IfStateChange notification
- restart-virtual-helper: null
-
Enable ospfv3VirtNbrRestartHelperStatusChange notification
- restart-helper: null
-
Enable ospfv3NbrRestartHelperStatusChange notification
- restart: null
-
Enable ospfv3RestartStatusChange notification
Example
{
"nssa-translator": [ null ],
"virtual-neighbor": [ null ],
"virtual-interface": [ null ],
"neighbor": [ null ],
"interface": [ null ],
"restart-virtual-helper": [ null ],
"restart-helper": [ null ],
"restart": [ null ]
}
a1_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a1_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a1_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a1_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a1_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a1_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a1_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a1_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a1_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"second"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a1_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"second"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a1_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"second"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a1_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a1_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a1_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a1_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"millisecond" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a1_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a1_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a1_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a1_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - threshold: integer
-
Threshold request feature timeout
range:"0..100000" units:"second" default:"50000" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"threshold": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a1_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a1_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a1_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a1_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a1_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a1_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a1_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a1_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}